SetRestrained - Actor

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search

Member of: Actor Script

Flags this actor as restrained or not.

Syntax[edit | edit source]

bool Function SetRestrained(bool abRestrained = true) native

Parameters[edit | edit source]

  • abRestrained: Whether to set or clear the actor's restrained status.
    • Default: True

Return Value[edit | edit source]

True if the restrained state was set. False otherwise (usually cause the actor is dead).

Examples[edit | edit source]

; Set Prisoner to restrained
Prisoner.SetRestrained()


; Clear Prisoner's restrained status
Prisoner.SetRestrained(false)

Notes[edit | edit source]

You cannot set/clear the restrained state on a dead actor.

See Also[edit | edit source]