Difference between revisions of "PlayIdleAction - Actor"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
m
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Animation]]
'''Member of:''' [[Actor Script]]
'''Member of:''' [[Actor Script]]



Latest revision as of 03:49, 25 October 2016

Member of: Actor Script

Attempts to play an idle from the action root passed.

Syntax[edit | edit source]

bool Function PlayIdleAction(Action aAction, ObjectReference aTarget = None) native

Parameters[edit | edit source]

  • aAction: The Action form the actor is attempting to play an idle from.
  • aTarget: Optional parameter noting the target of the actor's action.
    • Default: None

Return Value[edit | edit source]

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

Examples[edit | edit source]

; Make Dogmeat Bark
 if DogmeatRef.PlayIdleAction(barkAction)
   Debug.Trace("Dogmeat barked!")
 else
   Debug.Trace("Something went wrong")
 endIf

Notes[edit | edit source]

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[edit | edit source]