Difference between revisions of "PlayIdle - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Terra Nova2
m (Added example for forcing actor to play idle with hands bound. Hmm kept getting 502 error when trying to comment out first line.)
Line 25: Line 25:
  endIf
  endIf
</source>
</source>
<br>
<source lang="papyrus">
Force Prisoner idle
Idle property OffsetBoundStandingStart auto


myActor.PlayIdle(OffsetBoundStandingStart)
</source>
== Notes ==
== 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.
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.

Revision as of 16:17, 21 March 2014

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
Idle property OffsetBoundStandingStart auto

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.

See Also