AnimationProcessCallback

Types

• enum AnimationMethodCallMode
• class Signal1

  Signal support.

• class Signal2

  Signal support.

Type members

• class var godotClassName: StringName

Instance members

• var animationChanged: Signal2

  Emitted when a queued animation plays after the previous animation finished. See also queue(name:).

• var assignedAnimation: String

  If playing, the current animation’s key, otherwise, the animation last played. When set, this changes the animation, but will not play it unless already playing. See also currentAnimation.

• var autoplay: String

  The key of the animation to play when the scene loads.

• var currentAnimation: String

  The key of the currently playing animation. If no animation is playing, the property’s value is an empty string. Changing this value does not restart the animation. See play(name:customBlend:customSpeed:fromEnd:) for more information on playing animations.

• var currentAnimationChanged: Signal1

  Emitted when currentAnimation changes.

• var currentAnimationLength: Double

  The length (in seconds) of the currently playing animation.

• var currentAnimationPosition: Double

  The position (in seconds) of the currently playing animation.

• var movieQuitOnFinish: Bool

  If true and the engine is running in Movie Maker mode (see MovieWriter), exits the engine with quit(exitCode:) as soon as an animation is done playing in this AnimationPlayer. A message is printed when the engine quits for this reason.

• var playbackAutoCapture: Bool

  If true, performs capture(name:duration:transType:easeType:) before playback automatically. This means just playWithCapture(name:duration:customBlend:customSpeed:fromEnd:transType:easeType:) is executed with default arguments instead of play(name:customBlend:customSpeed:fromEnd:).

• var playbackAutoCaptureDuration: Double

  See also playWithCapture(name:duration:customBlend:customSpeed:fromEnd:transType:easeType:) and capture(name:duration:transType:easeType:).

• var playbackAutoCaptureEaseType: Tween.EaseType

  The ease type of the capture interpolation. See also Tween.EaseType.

• var playbackAutoCaptureTransitionType: Tween.TransitionType

  The transition type of the capture interpolation. See also Tween.TransitionType.

• var playbackDefaultBlendTime: Double

  The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision.

• var speedScale: Double

  The speed scaling ratio. For example, if this value is 1, then the animation plays at normal speed. If it’s 0.5, then it plays at half speed. If it’s 2, then it plays at double speed.

• func animationGetNext(animationFrom: StringName) -> StringName

  Returns the key of the animation which is queued to play after the animationFrom animation.

• func animationSetNext(animationFrom: StringName, animationTo: StringName)

  Triggers the animationTo animation when the animationFrom animation completes.

• func clearQueue()

  Clears all queued, unplayed animations.

• func getBlendTime(animationFrom: StringName, animationTo: StringName) -> Double

  Returns the blend time (in seconds) between two animations, referenced by their keys.

• func getMethodCallMode() -> AnimationPlayer.AnimationMethodCallMode

  Returns the call mode used for “Call Method” tracks.

• func getPlayingSpeed() -> Double

  Returns the actual playing speed of current animation or 0 if not playing. This speed is the speedScale property multiplied by custom_speed argument specified when calling the play(name:customBlend:customSpeed:fromEnd:) method.

• func getProcessCallback() -> AnimationPlayer.AnimationProcessCallback

  Returns the process notification in which to update animations.

• func getQueue() -> PackedStringArray

  Returns a list of the animation keys that are currently queued to play.

• func getRoot() -> NodePath

  Returns the node which node path references will travel from.

• func isPlaying() -> Bool

  Returns true if an animation is currently playing (even if speedScale and/or custom_speed are 0).

• func pause()

  Pauses the currently playing animation. The currentAnimationPosition will be kept and calling play(name:customBlend:customSpeed:fromEnd:) or playBackwards(name:customBlend:) without arguments or with the same animation name as assignedAnimation will resume the animation.

• func play(name: StringName, customBlend: Double, customSpeed: Double, fromEnd: Bool)

  Plays the animation with key name. Custom blend times and speed can be set.

• func playBackwards(name: StringName, customBlend: Double)

  Plays the animation with key name in reverse.

• func playWithCapture(name: StringName, duration: Double, customBlend: Double, customSpeed: Double, fromEnd: Bool, transType: Tween.TransitionType, easeType: Tween.EaseType)

  See also capture(name:duration:transType:easeType:).

• func queue(name: StringName)

  Queues an animation for playback once the current one is done.

• func seek(seconds: Double, update: Bool, updateOnly: Bool)

  Seeks the animation to the seconds point in time (in seconds). If update is true, the animation updates too, otherwise it updates at process time. Events between the current frame and seconds are skipped.

• func setBlendTime(animationFrom: StringName, animationTo: StringName, sec: Double)

  Specifies a blend time (in seconds) between two animations, referenced by their keys.

• func setMethodCallMode(AnimationPlayer.AnimationMethodCallMode)

  Sets the call mode used for “Call Method” tracks.

• func setProcessCallback(mode: AnimationPlayer.AnimationProcessCallback)

  Sets the process notification in which to update animations.

• func setRoot(path: NodePath)

  Sets the node which node path references will travel from.

• func stop(keepState: Bool)

  Stops the currently playing animation. The animation position is reset to 0 and the custom_speed is reset to 1.0. See also pause.