UnregisterForAnimationEvent - ScriptObject

Revision as of 12:34, 3 December 2015 by imported>Plplecuyer
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ScriptObject

Unregisters this active magic effect/alias/form from the specified animation event on the specified reference.

Only the script that unregisters for an event will stop receiving it. Other scripts attached to the same form, alias, or magic effect will still receive the event if they registered for it seperately.

Syntax

Function UnregisterForAnimationEvent(ObjectReference akSender, string asEventName) native

Parameters

  • akSender: The ObjectReference the event was coming from.
  • asEventName: The event to no longer listen for.

Return Value

None

Examples

; Stop listening for the "reset" animation event from the object we are attached to
UnregisterForAnimationEvent(self, "Reset")

Notes

Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

See Also