PlayIdle function - Actor script | Starfield

Found in:

Vanilla

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.

Parameters

IdleakIdle
CK Wiki Description
The idle form to whose animation 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

Auto-Generated Example

Idle myIdle__akIdle

bool returnedValue = myActor__toCallFunctionOn.PlayIdle(myIdle__akIdle)

Actor
Actor.PlayIdleWithTarget(...)
Idle

Additional References

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