Inheritance #

AnimationNodeStateMachineTransition #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A transition within an AnimationNodeStateMachine connecting two AnimationRootNodes.

The path generated when using AnimationNodeStateMachinePlayback.travel is limited to the nodes connected by AnimationNodeStateMachineTransition.

You can set the timing and conditions of the transition in detail.

Members #

var advance_condition: StringName = &""#

Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the AnimationTree that can be controlled from code (see Using AnimationTree). For example, if AnimationTree.tree_root is an AnimationNodeStateMachine and advance_condition is set to "idle":

GDScript

$animation_tree.set("parameters/conditions/idle", is_on_floor and (linear_velocity.x == 0))

C#

GetNode("animation_tree").Set("parameters/conditions/idle", IsOnFloor && (LinearVelocity.X == 0));

var advance_expression: String = ""#

Use an expression as a condition for state machine transitions. It is possible to create complex animation advance conditions for switching between states and gives much greater flexibility for creating complex state machines by directly interfacing with the script code.

var advance_mode = ADVANCE_MODE_ENABLED#

Determines whether the transition should be disabled, enabled when using AnimationNodeStateMachinePlayback.travel, or traversed automatically if the advance_condition and advance_expression checks are true (if assigned).

var break_loop_at_end: bool = false#

If true, breaks the loop at the end of the loop cycle for transition, even if the animation is looping.

var priority: int = 1#

Lower priority transitions are preferred when travelling through the tree via AnimationNodeStateMachinePlayback.travel or advance_mode is set to ADVANCE_MODE_AUTO.

var reset: bool = true#

If true, the destination animation is played back from the beginning when switched.

var switch_mode = SWITCH_MODE_IMMEDIATE#

The transition type.

var xfade_curve: Curve#

Ease curve for better control over cross-fade between this state and the next. Should be a unit Curve.

var xfade_time: float = 0.0#

The time to cross-fade between this state and the next.

Note: AnimationNodeStateMachine transitions the current state immediately after the start of the fading. The precise remaining time can only be inferred from the main animation. When AnimationNodeOutput is considered as the most upstream, so the xfade_time is not scaled depending on the downstream delta. See also AnimationNodeOneShot.fadeout_time.

Methods #

Annotations #

Constants #

const SWITCH_MODE_IMMEDIATE = 0 enum SwitchMode#

Switch to the next state immediately. The current state will end and blend into the beginning of the new one.

const SWITCH_MODE_SYNC = 1 enum SwitchMode#

Switch to the next state immediately, but will seek the new state to the playback position of the old state.

const SWITCH_MODE_AT_END = 2 enum SwitchMode#

Wait for the current state playback to end, then switch to the beginning of the next state animation.

const ADVANCE_MODE_DISABLED = 0 enum AdvanceMode#

Don't use this transition.

const ADVANCE_MODE_ENABLED = 1 enum AdvanceMode#

Only use this transition during AnimationNodeStateMachinePlayback.travel.

const ADVANCE_MODE_AUTO = 2 enum AdvanceMode#

Automatically use this transition if the advance_condition and advance_expression checks are true (if assigned).

Constructors #

Enums #

SwitchMode#

AdvanceMode#

Operators #

Signals #

signal advance_condition_changed()#

Emitted when advance_condition is changed.

Theme Items #

Tutorials #