Background for Skyrim SE
Member of the Form script
voidfunctionUnregisterForAnimationEvent(ObjectReferenceakSender, stringasEventName)Native

Description

Wiki Description

Unregisters this active magic effect/alias/form from the specified Form.OnAnimationEvent(...) on the specified reference.

Documentation Comment

Unregister for the specified animation event from the specified object


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

Parameters

  1. ObjectReferenceakSender

    CK Wiki Description

    The ObjectReference the event was coming from.

  2. stringasEventName

    CK Wiki Description

    The event to no longer listen for.


Examples

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

Auto-Generated Example

ObjectReference myObjectReference__akSender
string myString__asEventName

myForm__toCallFunctionOn.UnregisterForAnimationEvent(myObjectReference__akSender, myString__asEventName)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.