AnimationNodeStateMachinePlayback

Inherits: Resource < Reference < 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")

Tutorials

• AnimationTree

Properties

bool

resource_local_to_scene

true (parent override)

Methods

float	get_current_length ( ) const
String	get_current_node ( ) const
float	get_current_play_position ( ) const
PoolStringArray	get_travel_path ( ) const
bool	is_playing ( ) const
void	start ( String node )
void	stop ( )
void	travel ( String to_node )

Method Descriptions

float get_current_length ( ) const

String get_current_node ( ) const

Returns the currently playing animation state.

float get_current_play_position ( ) const

Returns the playback position within the current animation state.

PoolStringArray get_travel_path ( ) const

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

bool is_playing ( ) const

Returns true if an animation is playing.

void start ( String node )

Starts playing the given animation.

void stop ( )

Stops the currently playing animation.

void travel ( String to_node )

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