AnimationNodeBlendTree — C# API

A sub-tree of many type AnimationNodes used for complex animations. Used by AnimationTree.

class AnimationNodeBlendTreeReckfellSharpInherits AnimationRootNode

A sub-tree of many type AnimationNodes used for complex animations. Used by AnimationTree.

This animation node may contain a sub-tree of any other type animation nodes, such as AnimationNodeTransition, AnimationNodeBlend2, AnimationNodeBlend3, AnimationNodeOneShot, etc. This is one of the most commonly used animation node roots. An AnimationNodeOutput node named output is created by default.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AnimationNodeBlendTreeConstructor

# AnimationNodeBlendTree

C#
public AnimationNodeBlendTree();

Properties1

GraphOffsetProperty

# GraphOffset

C#
public Vector2 GraphOffset { get; set; }

The global offset of all sub animation nodes.

Methods12

AddNodevoid

# AddNode

C#
public void AddNode(StringName name, AnimationNode node, Vector2? position = default);

Adds an AnimationNode at the given position. The name is used to identify the created sub animation node later.

Parameters
Name	Type	Default
`name`	`StringName`	—
`node`	`AnimationNode`	—
`position`	`Vector2?`	`default`

position

If the parameter is null, then the default value is new Vector2(0.0f, 0.0f).

ConnectNodevoid

# ConnectNode

C#
public void ConnectNode(StringName inputNode, int inputIndex, StringName outputNode);

Connects the output of an AnimationNode as input for another AnimationNode, at the input port specified by input_index.

Parameters
Name	Type	Default
`inputNode`	`StringName`	—
`inputIndex`	`int`	—
`outputNode`	`StringName`	—

DisconnectNodevoid

# DisconnectNode

C#
public void DisconnectNode(StringName inputNode, int inputIndex);

Disconnects the animation node connected to the specified input.

Parameters
Name	Type	Default
`inputNode`	`StringName`	—
`inputIndex`	`int`	—

GetGraphOffsetVector2

# GetGraphOffset

C#
public Vector2 GetGraphOffset();

Returns Vector2

GetNodeAnimationNode

# GetNode

C#
public AnimationNode GetNode(StringName name);

Returns the sub animation node with the specified name.

Parameters
Name	Type	Default
`name`	`StringName`	—

Returns AnimationNode

GetNodeListReckfell.Collections.Array<StringName>

# GetNodeList

C#
public Reckfell.Collections.Array<StringName> GetNodeList();

Returns a list containing the names of all sub animation nodes in this blend tree.

Returns Reckfell.Collections.Array<StringName>

GetNodePositionVector2

# GetNodePosition

C#
public Vector2 GetNodePosition(StringName name);

Returns the position of the sub animation node with the specified name.

Parameters
Name	Type	Default
`name`	`StringName`	—

Returns Vector2

HasNodebool

# HasNode

C#
public bool HasNode(StringName name);

Returns true if a sub animation node with specified name exists.

Parameters
Name	Type	Default
`name`	`StringName`	—

Returns bool

RemoveNodevoid

# RemoveNode

C#
public void RemoveNode(StringName name);

Removes a sub animation node.

Parameters
Name	Type	Default
`name`	`StringName`	—

RenameNodevoid

# RenameNode

C#
public void RenameNode(StringName name, StringName newName);

Changes the name of a sub animation node.

Parameters
Name	Type	Default
`name`	`StringName`	—
`newName`	`StringName`	—

SetGraphOffsetvoid

# SetGraphOffset

C#
public void SetGraphOffset(Vector2 offset);

Parameters
Name	Type	Default
`offset`	`Vector2`	—

SetNodePositionvoid

# SetNodePosition

C#
public void SetNodePosition(StringName name, Vector2 position);

Modifies the position of a sub animation node.

Parameters
Name	Type	Default
`name`	`StringName`	—
`position`	`Vector2`	—

Signals and events1

NodeChangedEvent

# NodeChanged

public event AnimationNodeBlendTree.NodeChangedEventHandler NodeChanged;

Emitted when the input port information is changed.

Handler parameters
Name	Type	Default
`nodeName`	`StringName`	—

Fields and constants6

ConnectionErrorConnectionExistsField

# ConnectionErrorConnectionExists

C#
public const long ConnectionErrorConnectionExists = 5;

The specified connection already exists.

ConnectionErrorNoInputField

# ConnectionErrorNoInput

C#
public const long ConnectionErrorNoInput = 1;

The input node is null.

ConnectionErrorNoInputIndexField

# ConnectionErrorNoInputIndex

C#
public const long ConnectionErrorNoInputIndex = 2;

The specified input port is out of range.

ConnectionErrorNoOutputField

# ConnectionErrorNoOutput

C#
public const long ConnectionErrorNoOutput = 3;

The output node is null.

ConnectionErrorSameNodeField

# ConnectionErrorSameNode

C#
public const long ConnectionErrorSameNode = 4;

Input and output nodes are the same.

ConnectionOkField

# ConnectionOk

C#
public const long ConnectionOk = 0;

The connection was successful.