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.

Checking the stable version of the documentation...

AnimationNodeBlendSpace2D

Inherits: AnimationRootNode < AnimationNode < Resource < RefCounted < Object

A set of AnimationRootNodes placed on 2D coordinates, crossfading between the three adjacent ones. Used by AnimationTree.

Description

A resource used by AnimationNodeBlendTree.

AnimationNodeBlendSpace1D represents a virtual 2D space on which AnimationRootNodes are placed. Outputs the linear blend of the three adjacent animations using a Vector2 weight. Adjacent in this context means the three AnimationRootNodes making up the triangle that contains the current value.

You can add vertices to the blend space with add_blend_point and automatically triangulate it by setting auto_triangles to true. Otherwise, use add_triangle and remove_triangle to triangulate the blend space by hand.

Tutorials

• Using AnimationTree

• Third Person Shooter Demo

Properties

bool	auto_triangles	true
BlendMode	blend_mode	0
Vector2	max_space	Vector2(1, 1)
Vector2	min_space	Vector2(-1, -1)
Vector2	snap	Vector2(0.1, 0.1)
bool	sync	false
String	x_label	"x"
String	y_label	"y"

Methods

void	add_blend_point ( AnimationRootNode node, Vector2 pos, int at_index=-1 )
void	add_triangle ( int x, int y, int z, int at_index=-1 )
int	get_blend_point_count ( ) const
AnimationRootNode	get_blend_point_node ( int point ) const
Vector2	get_blend_point_position ( int point ) const
int	get_triangle_count ( ) const
int	get_triangle_point ( int triangle, int point )
void	remove_blend_point ( int point )
void	remove_triangle ( int triangle )
void	set_blend_point_node ( int point, AnimationRootNode node )
void	set_blend_point_position ( int point, Vector2 pos )

---

Signals

triangles_updated ( )

Emitted every time the blend space's triangles are created, removed, or when one of their vertices changes position.

---

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