Index · Object → RefCounted → Resource → AnimationNodeStateMachinePlayback

AnimationNodeStateMachinePlayback

Provides playback control for an AnimationNodeStateMachine.

Class Description

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

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

Properties

var resource_local_to_scene: bool = true
Inherited from Resource (4)

Methods

func get_current_length() -> float

Returns the current state length.

Note: It is possible that any AnimationRootNode can be nodes as well as animations. This means that there can be multiple animations within a single state. Which animation length has priority depends on the nodes connected inside it. Also, if a transition does not reset, the remaining length at that point will be returned.

func get_current_node() -> StringName

Returns the currently playing animation state.

Note: When using a cross-fade, the current state changes to the next state immediately after the cross-fade begins.

func get_current_play_position() -> float

Returns the playback position within the current animation state.

func get_fading_from_length() -> float

Returns the playback state length of the node from get_fading_from_node(). Returns 0 if no animation fade is occurring.

func get_fading_from_node() -> StringName

Returns the starting state of currently fading animation.

func get_fading_from_play_position() -> float

Returns the playback position of the node from get_fading_from_node(). Returns 0 if no animation fade is occurring.

func get_fading_length() -> float

Returns the length of the current fade animation. Returns 0 if no animation fade is occurring.

func get_fading_position() -> float

Returns the playback position of the current fade animation. Returns 0 if no animation fade is occurring.

func get_travel_path() -> StringName[]

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

func is_playing() -> bool

Returns true if an animation is playing.

func next() -> void

If there is a next path by travel or auto advance, immediately transitions from the current state to the next state.

func start(node: StringName, reset: bool = true) -> void

Starts playing the given animation.

If reset is true, the animation is played from the beginning.

func stop() -> void

Stops the currently playing animation.

func travel(to_node: StringName, reset_on_teleport: bool = true) -> void

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

If the path does not connect from the current state, the animation will play after the state teleports.

If reset_on_teleport is true, the animation is played from the beginning when the travel cause a teleportation.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal state_finished(state: StringName)

Emitted when the state finishes playback. If state is a state machine set to grouped mode, its signals are passed through with its name prefixed.

If there is a crossfade, this will be fired when the influence of the get_fading_from_node() animation is no longer present.

signal state_started(state: StringName)

Emitted when the state starts playback. If state is a state machine set to grouped mode, its signals are passed through with its name prefixed.

Inherited from Resource (2)
signal changed()
Inherited from Object (2)