PlayIdle - Actor

From Creation Kit
Jump to: navigation, search

Member of: Actor Script

Plays the idle passed.

Syntax

bool Function PlayIdle(Idle akIdle) native

Parameters

  • akIdle: The idle form to whose animation to play on this actor.

Return Value

True if the idle was successfully loaded and played, false otherwise.

Examples

; Start Hadvar's flute animation
 if Hadvar.PlayIdle(fluteIdle)
   Debug.Trace("Hadvar is playing his flute!")
 else
   Debug.Trace("Something went wrong")
 endIf


;Force Prisoner idle. Below is how to properly setup an actor in the "bound hands" pose as seen in first scene of the game in helgen.
Idle property OffsetBoundStandingStart auto
 
;Place this inside an Event, Function, etc
myActor.PlayIdle(OffsetBoundStandingStart)

Notes

  • Too many things can happen while you are attempting to play an idle, so make sure to gracefully handle all circumstances. Never use the structure "play idle, wait for event" - this will inevitably cause your script to get stuck forever when some other code or script overrules your idle. Calling the PlayIdle function on the same actor, with the same idle again, will have the actor stop playing it (if it's a looped animation).
  • Some idles cannot be played with this function if the idle has an associated special furniture and is not listed in the idle manager. To which other means to force a player to play such an idle is required.
  • You cannot play an idle on an actor whose AI is disabled.

See Also