eventOnAnimationEventUnregistered(ObjectReferenceakSource, stringasEventName)
Description
Wiki Description
Received when one of the animation events we are listening for has been automatically unregistered by the game due to the target animation graph unloading. This event is not received when you manually unregister for the event.
This event will only be sent to the specific script that registered for it. Other scripts attached to the same form/alias/active magic effect will not receive the event unless they also register.
Documentation Comment
Event sent when you have been unregistered from receiving an animation event because the target
object's animation graph has been unloaded
Caveats
CK Wiki - Notes
- Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
Parameters
ObjectReferenceakSource
CK Wiki Description
The ObjectReference whose animation graph unloaded.
stringasEventName
CK Wiki Description
The event that can no longer be received.
Examples
Function SomeFunction()
RegisterForAnimationEvent(JoeBob, "IdleFurnitureExit") ; Before we can use OnAnimationEvent we must register.
EndFunction
Event OnAnimationEventUnregistered(ObjectReference akSource, string asEventName)
if (akSource == JoeBob) && (asEventName == "IdleFurnitureExit")
Debug.Trace("We got unregistered for JoeBob's funiture exit event, do any necessary cleanup here")
endIf
endEventAuto-Generated Example
Scriptname MyCoolScript extends ScriptObject
event OnAnimationEventUnregistered(ObjectReference akSource, string asEventName)
Debug.trace("Event received - OnAnimationEventUnregistered: akSource = " + akSource + " asEventName = " + asEventName)
endEvent