Difference between revisions of "UnregisterForAnimationEvent - Form"
Jump to navigation
Jump to search
imported>Rhavlovick m (1 revision: Clobber re-import by Henning) |
imported>JLundin |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
[[Category:Non-delayed Native Function]] | |||
'''Member of:''' [[ActiveMagicEffect Script]], [[Alias Script]], and [[Form Script]] | '''Member of:''' [[ActiveMagicEffect Script]], [[Alias Script]], and [[Form Script]] | ||
| Line 24: | Line 25: | ||
== 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 == | ||
Latest revision as of 08:03, 12 September 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[edit | edit source]
Function UnregisterForAnimationEvent(ObjectReference akSender, string asEventName) nativeParameters[edit | edit source]
- akSender: The ObjectReference the event was coming from.
- asEventName: The event to no longer listen for.
Return Value[edit | edit source]
None
Examples[edit | edit source]
; Stop listening for the "reset" animation event from the object we are attached to
UnregisterForAnimationEvent(self, "Reset")Notes[edit | edit source]
- 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.