:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendTree.xml. .. _class_AnimationNodeBlendTree: AnimationNodeBlendTree ====================== **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A sub-tree of many type :ref:`AnimationNode`\ s used for complex animations. Used by :ref:`AnimationTree`. .. rst-class:: classref-introduction-group Description ----------- This animation node may contain a sub-tree of any other type animation nodes, such as :ref:`AnimationNodeTransition`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeOneShot`, etc. This is one of the most commonly used animation node roots. An :ref:`AnimationNodeOutput` node named ``output`` is created by default. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using AnimationTree <../tutorials/animation/animation_tree>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+-------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`graph_offset` | ``Vector2(0, 0)`` | +-------------------------------+-------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_AnimationNodeBlendTree_signal_node_changed: .. rst-class:: classref-signal **node_changed**\ (\ node_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when the input port information is changed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_AnimationNodeBlendTree_constant_CONNECTION_OK: .. rst-class:: classref-constant **CONNECTION_OK** = ``0`` :ref:`🔗` The connection was successful. .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT: .. rst-class:: classref-constant **CONNECTION_ERROR_NO_INPUT** = ``1`` :ref:`🔗` The input node is ``null``. .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT_INDEX: .. rst-class:: classref-constant **CONNECTION_ERROR_NO_INPUT_INDEX** = ``2`` :ref:`🔗` The specified input port is out of range. .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_OUTPUT: .. rst-class:: classref-constant **CONNECTION_ERROR_NO_OUTPUT** = ``3`` :ref:`🔗` The output node is ``null``. .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_SAME_NODE: .. rst-class:: classref-constant **CONNECTION_ERROR_SAME_NODE** = ``4`` :ref:`🔗` Input and output nodes are the same. .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_CONNECTION_EXISTS: .. rst-class:: classref-constant **CONNECTION_ERROR_CONNECTION_EXISTS** = ``5`` :ref:`🔗` The specified connection already exists. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimationNodeBlendTree_property_graph_offset: .. rst-class:: classref-property :ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_graph_offset**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_graph_offset**\ (\ ) The global offset of all sub animation nodes. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimationNodeBlendTree_method_add_node: .. rst-class:: classref-method |void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) :ref:`🔗` Adds an :ref:`AnimationNode` at the given ``position``. The ``name`` is used to identify the created sub animation node later. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_connect_node: .. rst-class:: classref-method |void| **connect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) :ref:`🔗` Connects the output of an :ref:`AnimationNode` as input for another :ref:`AnimationNode`, at the input port specified by ``input_index``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_disconnect_node: .. rst-class:: classref-method |void| **disconnect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) :ref:`🔗` Disconnects the animation node connected to the specified input. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_get_node: .. rst-class:: classref-method :ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the sub animation node with the specified ``name``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_get_node_position: .. rst-class:: classref-method :ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the position of the sub animation node with the specified ``name``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_has_node: .. rst-class:: classref-method :ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a sub animation node with specified ``name`` exists. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_remove_node: .. rst-class:: classref-method |void| **remove_node**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes a sub animation node. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_rename_node: .. rst-class:: classref-method |void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) :ref:`🔗` Changes the name of a sub animation node. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendTree_method_set_node_position: .. rst-class:: classref-method |void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) :ref:`🔗` Modifies the position of a sub animation node. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`