OnAnimationEvent - Form

Member of: ActiveMagicEffect Script, Alias Script, and Form Script

Event called when the active magic effect/alias/form receives one of the animation events it was listening for.

Syntax

Event OnAnimationEvent(ObjectReference akSource, string asEventName)

Parameters

• akSource: The ObjectReference that sent the event.
• asEventName: The event that was received.

Examples

Function SomeFunction()
  RegisterForAnimationEvent(JoeBob, "IdleFurnitureExit") ; Before we can use OnAnimationEvent we must register.
EndFunction

Event OnAnimationEvent(ObjectReference akSource, string asEventName)
  if (akSource == self) && (asEventName == "Reset")
    Debug.Trace("We got the reset animation graph event from ourselves that we were looking for!")
  endIf
endEvent

Notes

• Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
• This event is not relayed to any aliases or magic effects attached to the form.
• This event is relayed to other scripts attached to the same object. eg. On a quest form with 2 main quest scripts and a fragment script, an update event registered by one will be received by all three.

See Also

• ActiveMagicEffect Script
• Alias Script
• Form Script
• RegisterForAnimationEvent - Form
• UnregisterForAnimationEvent - Form