WaitForAnimationEvent - ObjectReference: Difference between revisions

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Scornett
m (Reverted edits by Scornett-Bot (talk) to last revision by Jlundin)
 
m (Convert source tags to syntaxhighlight)
 
Line 7: Line 7:


== Syntax ==
== Syntax ==
<source lang="papyrus">
<syntaxhighlight lang="papyrus">
bool Function WaitForAnimationEvent(string asEventName) native
bool Function WaitForAnimationEvent(string asEventName) native
</source>
</syntaxhighlight>


== Parameters ==
== Parameters ==
Line 18: Line 18:


== Examples ==
== Examples ==
<source lang="papyrus">
<syntaxhighlight lang="papyrus">
; Wait for the done event to happen before continuing
; Wait for the done event to happen before continuing
CoolThing.WaitForAnimationEvent("done")
CoolThing.WaitForAnimationEvent("done")
</source>
</syntaxhighlight>


== See Also ==
== See Also ==
*[[ObjectReference Script]]
*[[ObjectReference Script]]
*[[PlayAnimation - ObjectReference]]
*[[PlayAnimation - ObjectReference]]

Latest revision as of 20:25, 5 September 2026

Member of: ObjectReference Script

Waits for the specified animation event from this object to happen before returning.

Syntax[edit | edit source]

bool Function WaitForAnimationEvent(string asEventName) native

Parameters[edit | edit source]

  • asEventName: The event to wait for

Return Value[edit | edit source]

True if the event happened, false if the animation graph unloaded before the event was sent.

Examples[edit | edit source]

; Wait for the done event to happen before continuing
CoolThing.WaitForAnimationEvent("done")

See Also[edit | edit source]