Index · Object → RefCounted → Resource → AnimationNode → AnimationRootNode → AnimationNodeStateMachine

AnimationNodeStateMachine

A state machine with multiple AnimationRootNodes, used by AnimationTree.

Class Description

Contains multiple AnimationRootNodes representing animation states, connected in a graph. State transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the AnimationTree node to control it programmatically.

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

Properties

var allow_transition_to_self: bool = false

If true, allows teleport to the self state with AnimationNodeStateMachinePlayback.travel(). When the reset option is enabled in AnimationNodeStateMachinePlayback.travel(), the animation is restarted. If false, nothing happens on the teleportation to the self state.

var reset_ends: bool = false

If true, treat the cross-fade to the start and end nodes as a blend with the RESET animation.

In most cases, when additional cross-fades are performed in the parent AnimationNode of the state machine, setting this property to false and matching the cross-fade time of the parent AnimationNode and the state machine's start node and end node gives good results.

var state_machine_type: AnimationNodeStateMachine.StateMachineType = 0

This property can define the process of transitions for different use cases. See also StateMachineType.

Inherited from AnimationNode (1)
Inherited from Resource (4)

Methods

func add_node(name: StringName, node: AnimationNode, position: Vector2 = Vector2(0, 0)) -> void

Adds a new animation node to the graph. The position is used for display in the editor.

func add_transition(from: StringName, to: StringName, transition: AnimationNodeStateMachineTransition) -> void

Adds a transition between the given animation nodes.

func get_graph_offset() -> Vector2

Returns the draw offset of the graph. Used for display in the editor.

func get_node(name: StringName) -> AnimationNode

Returns the animation node with the given name.

func get_node_list() -> StringName[]

Returns a list containing the names of all animation nodes in this state machine.

func get_node_name(node: AnimationNode) -> StringName

Returns the given animation node's name.

func get_node_position(name: StringName) -> Vector2

Returns the given animation node's coordinates. Used for display in the editor.

func get_transition(idx: int) -> AnimationNodeStateMachineTransition

Returns the given transition.

func get_transition_count() -> int

Returns the number of connections in the graph.

func get_transition_from(idx: int) -> StringName

Returns the given transition's start node.

func get_transition_to(idx: int) -> StringName

Returns the given transition's end node.

func has_node(name: StringName) -> bool

Returns true if the graph contains the given animation node.

func has_transition(from: StringName, to: StringName) -> bool

Returns true if there is a transition between the given animation nodes.

func remove_node(name: StringName) -> void

Deletes the given animation node from the graph.

func remove_transition(from: StringName, to: StringName) -> void

Deletes the transition between the two specified animation nodes.

func remove_transition_by_index(idx: int) -> void

Deletes the given transition by index.

func rename_node(name: StringName, new_name: StringName) -> void

Renames the given animation node.

func replace_node(name: StringName, node: AnimationNode) -> void

Replaces the given animation node with a new animation node.

func set_graph_offset(offset: Vector2) -> void

Sets the draw offset of the graph. Used for display in the editor.

func set_node_position(name: StringName, position: Vector2) -> void

Sets the animation node's coordinates. Used for display in the editor.

Inherited from AnimationNode (23)
func _has_filter() -> bool
func _process(time: float, seek: bool, is_external_seeking: bool, test_only: bool) -> float
func add_input(name: String) -> bool
func blend_animation(animation: StringName, time: float, delta: float, seeked: bool, is_external_seeking: bool, blend: float, looped_flag: Animation.LoopedFlag = 0) -> void
func blend_input(input_index: int, time: float, seek: bool, is_external_seeking: bool, blend: float, filter: AnimationNode.FilterAction = 0, sync: bool = true, test_only: bool = false) -> float
func blend_node(name: StringName, node: AnimationNode, time: float, seek: bool, is_external_seeking: bool, blend: float, filter: AnimationNode.FilterAction = 0, sync: bool = true, test_only: bool = false) -> float
func find_input(name: String) -> int
func get_input_name(input: int) -> String
func remove_input(index: int) -> void
func set_filter_path(path: NodePath, enable: bool) -> void
func set_input_name(input: int, name: String) -> bool
func set_parameter(name: StringName, value: Variant) -> void
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

Inherited from AnimationNode (4)
signal animation_node_removed(object_id: int, node_name: String)
signal animation_node_renamed(object_id: int, old_name: String, new_name: String)
signal node_updated(object_id: int)
signal tree_changed()
Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum StateMachineType
STATE_MACHINE_TYPE_ROOT = 0

Seeking to the beginning is treated as playing from the start state. Transition to the end state is treated as exiting the state machine.

STATE_MACHINE_TYPE_NESTED = 1

Seeking to the beginning is treated as seeking to the beginning of the animation in the current state. Transition to the end state, or the absence of transitions in each state, is treated as exiting the state machine.

STATE_MACHINE_TYPE_GROUPED = 2

This is a grouped state machine that can be controlled from a parent state machine. It does not work independently. There must be a state machine with state_machine_type of STATE_MACHINE_TYPE_ROOT or STATE_MACHINE_TYPE_NESTED in the parent or ancestor.