Background for Fallout 4
Member of the ObjectReference script
boolfunctionPlayGamebryoAnimation(stringasAnimation, boolabStartOver=false, floatafEaseInTime=0.0)Native

Description

Wiki Description

Plays a legacy nif file based animation, optionally starting the animation over from the beginning with the specified ease-in time.

Documentation Comment

Start the specified Gamebryo animation playing - returns true if it succeeds


Caveats

CK Wiki - Notes

Gamebryo animations do not persist through a game load.


Parameters

stringasAnimation

CK Wiki Description

The animation to play.

boolabStartOver=false

CK Wiki Description

Should the animation start over from the beginning?

floatafEaseInTime=0.0

CK Wiki Description

The amount of time to take to ease-in the animation, in seconds.


Examples

; Play the forward animation, don't start over, and don't ease it in
DoorRef.PlayGamebryoAnimation("Forward")
; Play the forward animation and ease it in over 1 second
DoorRef.PlayGamebryoAnimation("Forward", afEaseInTime = 1.0)

Auto-Generated Example

string myString__asAnimation
bool myBool__abStartOver
float myFloat__afEaseInTime

bool returnedValue = myObjectReference__toCallFunctionOn.PlayGamebryoAnimation(myString__asAnimation, myBool__abStartOver, myFloat__afEaseInTime)

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.