Background for Fallout 4
Member of the ScriptObject script
voidfunctionUnregisterForAnimationEvent(ObjectReferenceakSender, stringasEventName)Native

Description

Wiki Description

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.

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.


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

myScriptObject__toCallFunctionOn.UnregisterForAnimationEvent(myObjectReference__akSender, myString__asEventName)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.