PlayGamebryoAnimation - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

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

Syntax

bool Function PlayGamebryoAnimation(string asAnimation, bool abStartOver = false, float afEaseInTime = 0.0) native

Parameters

  • asAnimation: The animation to play.
  • abStartOver: Should the animation start over from the beginning?
    • Default: false
  • afEaseInTime: The amount of time to take to ease-in the animation, in seconds.
    • Default: 0.0

Return Value

True if the animation was started.

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)

See Also