AnimationNodeStateMachinePlayback

Inherits: Resource < RefCounted < Object

Playback control for AnimationNodeStateMachine.

Description

Allows control of AnimationTree state machines created with AnimationNodeStateMachine. Retrieve with $AnimationTree.get("parameters/playback").

Example:

var state_machine = $AnimationTree.get("parameters/playback")
state_machine.travel("some_state")

Properties

bool

resource_local_to_scene

true (parent override)

Methods

float

get_current_length ( ) const

StringName

get_current_node ( ) const

float

get_current_play_position ( ) const

PackedStringArray

get_travel_path ( ) const

bool

is_playing ( ) const

void

start ( StringName node )

void

stop ( )

void

travel ( StringName to_node )

Method Descriptions

  • float get_current_length ( ) const


Returns the currently playing animation state.


  • float get_current_play_position ( ) const

Returns the playback position within the current animation state.


Returns the current travel path as computed internally by the A* algorithm.


  • bool is_playing ( ) const

Returns true if an animation is playing.


Starts playing the given animation.


  • void stop ( )

Stops the currently playing animation.


Transitions from the current state to another one, following the shortest path.