Background for Fallout 4
Member of the Actor script
boolfunctionSetRestrained(boolabRestrained=true)Native

Description

Wiki Description

Flags this actor as restrained or not.

Documentation Comment

Sets this actor as restrained or not - returns false if the state wasn't changed


Caveats

CK Wiki - Notes

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


Parameters

boolabRestrained=true

CK Wiki Description

Whether to set or clear the actor's restrained status.

  • Default:True

Examples

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

Auto-Generated Example

bool myBool__abRestrained

bool returnedValue = myActor__toCallFunctionOn.SetRestrained(myBool__abRestrained)

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.