SetAnimationVariableBool function - ObjectReference script

Found in:

Vanilla
SKSE

voidfunctionSetAnimationVariableBool(stringarVariableName, boolabNewValue)Native

Description

Wiki Description

Sets the value of a variable on the reference's animation graph - Bool version.

Documentation Comment

Set a variable on the reference's animation graph (if applicable). Bool version.

Caveats

CK Wiki - Notes

A full list of variables can be found here: List of Animation Variables.

Parameters

stringarVariableName
CK Wiki Description
The name of the variable to read from the graph.
boolabNewValue
CK Wiki Description
The new variable value.

Examples

; Force graph in to animation driven state
SetAnimationVariableBool("bAnimationDriven", true)

Auto-Generated Example

string myString__arVariableName
bool myBool__abNewValue

myObjectReference__toCallFunctionOn.SetAnimationVariableBool(myString__arVariableName, myBool__abNewValue)

ObjectReference
ObjectReference.GetAnimationVariableBool(...)
ObjectReference.GetAnimationVariableInt(...)
ObjectReference.GetAnimationVariableFloat(...)
ObjectReference.SetAnimationVariableInt(...)
ObjectReference.SetAnimationVariableFloat(...)

Additional References

View this function’s page on the Skyrim Creation Kit Wiki