Difference between revisions of "UnregisterForAnimationEvent - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Fg109
Line 24: Line 24:


== Notes ==
== Notes ==
Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
*Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
*This function doesn't work if called within an [[OnAnimationEvent_-_Form|OnAnimationEvent]] unless there is a [[Wait_-_Utility|wait]] preceding it.


== See Also ==
== See Also ==

Revision as of 00:13, 14 April 2012

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

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

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.
  • This function doesn't work if called within an OnAnimationEvent unless there is a wait preceding it.

See Also