Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

AnimationNodeBlendSpace1D

Inherits: AnimationRootNode < AnimationNode < Resource < RefCounted < Object

A set of AnimationRootNodes placed on a virtual axis, crossfading between the two adjacent ones. Used by AnimationTree.

Description

A resource used by AnimationNodeBlendTree.

AnimationNodeBlendSpace1D represents a virtual axis on which any type of AnimationRootNodes can be added using add_blend_point. Outputs the linear blend of the two AnimationRootNodes adjacent to the current value.

You can set the extents of the axis with min_space and max_space.

Tutorials

Properties

BlendMode

blend_mode

0

float

max_space

1.0

float

min_space

-1.0

float

snap

0.1

bool

sync

false

String

value_label

"value"

Methods

void

add_blend_point ( AnimationRootNode node, float pos, int at_index=-1 )

int

get_blend_point_count ( ) const

AnimationRootNode

get_blend_point_node ( int point ) const

float

get_blend_point_position ( int point ) const

void

remove_blend_point ( int point )

void

set_blend_point_node ( int point, AnimationRootNode node )

void

set_blend_point_position ( int point, float pos )


Enumerations

enum BlendMode:

BlendMode BLEND_MODE_INTERPOLATED = 0

The interpolation between animations is linear.

BlendMode BLEND_MODE_DISCRETE = 1

The blend space plays the animation of the animation node which blending position is closest to. Useful for frame-by-frame 2D animations.

BlendMode BLEND_MODE_DISCRETE_CARRY = 2

Similar to BLEND_MODE_DISCRETE, but starts the new animation at the last animation's playback position.


Property Descriptions

BlendMode blend_mode = 0

Controls the interpolation between animations. See BlendMode constants.


float max_space = 1.0

  • void set_max_space ( float value )

  • float get_max_space ( )

The blend space's axis's upper limit for the points' position. See add_blend_point.


float min_space = -1.0

  • void set_min_space ( float value )

  • float get_min_space ( )

The blend space's axis's lower limit for the points' position. See add_blend_point.


float snap = 0.1

  • void set_snap ( float value )