godot-docs/classes/class_animationtree.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationTree.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AnimationTree:

AnimationTree
=============

**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

A node to be used for advanced animation transitions in an :ref:`AnimationPlayer<class_AnimationPlayer>`.

Description
-----------

A node to be used for advanced animation transitions in an :ref:`AnimationPlayer<class_AnimationPlayer>`.

**Note:** When linked with an :ref:`AnimationPlayer<class_AnimationPlayer>`, several properties and methods of the corresponding :ref:`AnimationPlayer<class_AnimationPlayer>` will not function as expected. Playback and transitions should be handled using only the ``AnimationTree`` and its constituent :ref:`AnimationNode<class_AnimationNode>`\ (s). The :ref:`AnimationPlayer<class_AnimationPlayer>` node should be used solely for adding, deleting, and editing animations.

Tutorials
---------

- :doc:`../tutorials/animation/animation_tree`

- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__

Properties
----------

+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
| :ref:`bool<class_bool>`                                                      | :ref:`active<class_AnimationTree_property_active>`                       | ``false``        |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
| :ref:`NodePath<class_NodePath>`                                              | :ref:`anim_player<class_AnimationTree_property_anim_player>`             | ``NodePath("")`` |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
| :ref:`AnimationProcessCallback<enum_AnimationTree_AnimationProcessCallback>` | :ref:`process_callback<class_AnimationTree_property_process_callback>`   | ``1``            |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
| :ref:`NodePath<class_NodePath>`                                              | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` | ``NodePath("")`` |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
| :ref:`AnimationNode<class_AnimationNode>`                                    | :ref:`tree_root<class_AnimationTree_property_tree_root>`                 |                  |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+

Methods
-------

+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                  | :ref:`advance<class_AnimationTree_method_advance>` **(** :ref:`float<class_float>` delta **)**                                                              |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`get_root_motion_transform<class_AnimationTree_method_get_root_motion_transform>` **(** **)** |const|                                                  |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                  | :ref:`rename_parameter<class_AnimationTree_method_rename_parameter>` **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)** |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_AnimationTree_AnimationProcessCallback:

.. _class_AnimationTree_constant_ANIMATION_PROCESS_PHYSICS:

.. _class_AnimationTree_constant_ANIMATION_PROCESS_IDLE:

.. _class_AnimationTree_constant_ANIMATION_PROCESS_MANUAL:

enum **AnimationProcessCallback**:

- **ANIMATION_PROCESS_PHYSICS** = **0** --- The animations will progress during the physics frame (i.e. :ref:`Node._physics_process<class_Node_method__physics_process>`).

- **ANIMATION_PROCESS_IDLE** = **1** --- The animations will progress during the idle frame (i.e. :ref:`Node._process<class_Node_method__process>`).

- **ANIMATION_PROCESS_MANUAL** = **2** --- The animations will only progress manually (see :ref:`advance<class_AnimationTree_method_advance>`).

Property Descriptions
---------------------

.. _class_AnimationTree_property_active:

- :ref:`bool<class_bool>` **active**

+-----------+-------------------+
| *Default* | ``false``         |
+-----------+-------------------+
| *Setter*  | set_active(value) |
+-----------+-------------------+
| *Getter*  | is_active()       |
+-----------+-------------------+

If ``true``, the ``AnimationTree`` will be processing.

----

.. _class_AnimationTree_property_anim_player:

- :ref:`NodePath<class_NodePath>` **anim_player**

+-----------+-----------------------------+
| *Default* | ``NodePath("")``            |
+-----------+-----------------------------+
| *Setter*  | set_animation_player(value) |
+-----------+-----------------------------+
| *Getter*  | get_animation_player()      |
+-----------+-----------------------------+

The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` used for animating.

----

.. _class_AnimationTree_property_process_callback:

- :ref:`AnimationProcessCallback<enum_AnimationTree_AnimationProcessCallback>` **process_callback**

+-----------+-----------------------------+
| *Default* | ``1``                       |
+-----------+-----------------------------+
| *Setter*  | set_process_callback(value) |
+-----------+-----------------------------+
| *Getter*  | get_process_callback()      |
+-----------+-----------------------------+

The process mode of this ``AnimationTree``. See :ref:`AnimationProcessCallback<enum_AnimationTree_AnimationProcessCallback>` for available modes.

----

.. _class_AnimationTree_property_root_motion_track:

- :ref:`NodePath<class_NodePath>` **root_motion_track**

+-----------+------------------------------+
| *Default* | ``NodePath("")``             |
+-----------+------------------------------+
| *Setter*  | set_root_motion_track(value) |
+-----------+------------------------------+
| *Getter*  | get_root_motion_track()      |
+-----------+------------------------------+

The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by ``":"``. For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local"``.

If the track has type :ref:`Animation.TYPE_POSITION_3D<class_Animation_constant_TYPE_POSITION_3D>`, :ref:`Animation.TYPE_ROTATION_3D<class_Animation_constant_TYPE_ROTATION_3D>` or :ref:`Animation.TYPE_SCALE_3D<class_Animation_constant_TYPE_SCALE_3D>` the transformation will be cancelled visually, and the animation will appear to stay in place. See also :ref:`get_root_motion_transform<class_AnimationTree_method_get_root_motion_transform>` and :ref:`RootMotionView<class_RootMotionView>`.

----

.. _class_AnimationTree_property_tree_root:

- :ref:`AnimationNode<class_AnimationNode>` **tree_root**

+----------+----------------------+
| *Setter* | set_tree_root(value) |
+----------+----------------------+
| *Getter* | get_tree_root()      |
+----------+----------------------+

The root animation node of this ``AnimationTree``. See :ref:`AnimationNode<class_AnimationNode>`.

Method Descriptions
-------------------

.. _class_AnimationTree_method_advance:

- void **advance** **(** :ref:`float<class_float>` delta **)**

Manually advance the animations by the specified time (in seconds).

----

.. _class_AnimationTree_method_get_root_motion_transform:

- :ref:`Transform3D<class_Transform3D>` **get_root_motion_transform** **(** **)** |const|

Retrieve the motion of the :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` as a :ref:`Transform3D<class_Transform3D>` that can be used elsewhere. If :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` is not a path to a track of type :ref:`Animation.TYPE_POSITION_3D<class_Animation_constant_TYPE_POSITION_3D>`, :ref:`Animation.TYPE_SCALE_3D<class_Animation_constant_TYPE_SCALE_3D>` or :ref:`Animation.TYPE_ROTATION_3D<class_Animation_constant_TYPE_ROTATION_3D>`, returns an identity transformation. See also :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` and :ref:`RootMotionView<class_RootMotionView>`.

----

.. _class_AnimationTree_method_rename_parameter:

- void **rename_parameter** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**

.. |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.)`