Background for Skyrim SE
Member of the Actor script
boolfunctionPlayIdle(IdleakIdle)Native

Description

Wiki Description

Plays the idle passed.

Documentation Comment

Send an idle to the actor to load in and play.


Caveats

CK Wiki - 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.

Parameters

IdleakIdle

CK Wiki Description

The idle to play on this actor.


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)

Auto-Generated Example

Idle myIdle__akIdle

bool returnedValue = myActor__toCallFunctionOn.PlayIdle(myIdle__akIdle)

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.