Background for Fallout 4
Member of the Actor script
boolfunctionPlayIdleAction(ActionaAction, ObjectReferenceaTarget=NONE)Native

Description

Wiki Description

Attempts to play an idle from the action root passed.

Documentation Comment

Attempts to run action on actor.


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

ActionaAction

CK Wiki Description

The Action form the actor is attempting to play an idle from.

ObjectReferenceaTarget=NONE

CK Wiki Description

Optional parameter noting the target of the actor's action.

  • Default:None

Examples

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

Auto-Generated Example

Action myAction__aAction
ObjectReference myObjectReference__aTarget

bool returnedValue = myActor__toCallFunctionOn.PlayIdleAction(myAction__aAction, myObjectReference__aTarget)

Related Pages


Additional References

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

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.