godot-docs/classes/class_animationtreeplayer.rst

:github_url: hide

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

.. _class_AnimationTreePlayer:

AnimationTreePlayer
===================

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

Animation player that uses a node graph for blending animations.

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

A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer<class_AnimationPlayer>`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.

It takes :ref:`Animation<class_Animation>`\ s from an :ref:`AnimationPlayer<class_AnimationPlayer>` node and mixes them depending on the graph.

Tutorials
---------

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

Properties
----------

+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>`                                                    | :ref:`active<class_AnimationTreePlayer_property_active>`                               | ``false``          |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| :ref:`NodePath<class_NodePath>`                                            | :ref:`base_path<class_AnimationTreePlayer_property_base_path>`                         | ``NodePath("..")`` |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| :ref:`NodePath<class_NodePath>`                                            | :ref:`master_player<class_AnimationTreePlayer_property_master_player>`                 | ``NodePath("")``   |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` | ``1``              |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+

Methods
-------

+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`add_node<class_AnimationTreePlayer_method_add_node>` **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)**                                                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`advance<class_AnimationTreePlayer_method_advance>` **(** :ref:`float<class_float>` delta **)**                                                                                                                               |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_Animation>`                  | :ref:`animation_node_get_animation<class_AnimationTreePlayer_method_animation_node_get_animation>` **(** :ref:`String<class_String>` id **)** const                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                        | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_method_animation_node_get_master_animation>` **(** :ref:`String<class_String>` id **)** const                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`animation_node_get_position<class_AnimationTreePlayer_method_animation_node_get_position>` **(** :ref:`String<class_String>` id **)** const                                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`animation_node_set_animation<class_AnimationTreePlayer_method_animation_node_set_animation>` **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)**                                         |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_method_animation_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_method_animation_node_set_master_animation>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)**                                    |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`are_nodes_connected<class_AnimationTreePlayer_method_are_nodes_connected>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const                         |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_method_blend2_node_get_amount>` **(** :ref:`String<class_String>` id **)** const                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_method_blend2_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**                                                                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_method_blend2_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_method_blend3_node_get_amount>` **(** :ref:`String<class_String>` id **)** const                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_method_blend3_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**                                                                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`                      | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_method_blend4_node_get_amount>` **(** :ref:`String<class_String>` id **)** const                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_method_blend4_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)**                                                             |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>`              | :ref:`connect_nodes<class_AnimationTreePlayer_method_connect_nodes>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)**                                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`disconnect_nodes<class_AnimationTreePlayer_method_disconnect_nodes>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)**                                                                         |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>`      | :ref:`get_node_list<class_AnimationTreePlayer_method_get_node_list>` **(** **)**                                                                                                                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`mix_node_get_amount<class_AnimationTreePlayer_method_mix_node_get_amount>` **(** :ref:`String<class_String>` id **)** const                                                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`mix_node_set_amount<class_AnimationTreePlayer_method_mix_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)**                                                                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`node_exists<class_AnimationTreePlayer_method_node_exists>` **(** :ref:`String<class_String>` node **)** const                                                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                              | :ref:`node_get_input_count<class_AnimationTreePlayer_method_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const                                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                        | :ref:`node_get_input_source<class_AnimationTreePlayer_method_node_get_input_source>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const                                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`                      | :ref:`node_get_position<class_AnimationTreePlayer_method_node_get_position>` **(** :ref:`String<class_String>` id **)** const                                                                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` | :ref:`node_get_type<class_AnimationTreePlayer_method_node_get_type>` **(** :ref:`String<class_String>` id **)** const                                                                                                              |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>`              | :ref:`node_rename<class_AnimationTreePlayer_method_node_rename>` **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)**                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`node_set_position<class_AnimationTreePlayer_method_node_set_position>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)**                                                             |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_String>` id **)** const                                                                    |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_String>` id **)** const                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_method_oneshot_node_get_fadein_time>` **(** :ref:`String<class_String>` id **)** const                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_String>` id **)** const                                                                              |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_method_oneshot_node_has_autorestart>` **(** :ref:`String<class_String>` id **)** const                                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_method_oneshot_node_is_active>` **(** :ref:`String<class_String>` id **)** const                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_method_oneshot_node_set_autorestart>` **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)**                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)**                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)**                        |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_method_oneshot_node_set_fadein_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_method_oneshot_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_start<class_AnimationTreePlayer_method_oneshot_node_start>` **(** :ref:`String<class_String>` id **)**                                                                                                          |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`oneshot_node_stop<class_AnimationTreePlayer_method_oneshot_node_stop>` **(** :ref:`String<class_String>` id **)**                                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`recompute_caches<class_AnimationTreePlayer_method_recompute_caches>` **(** **)**                                                                                                                                             |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`remove_node<class_AnimationTreePlayer_method_remove_node>` **(** :ref:`String<class_String>` id **)**                                                                                                                        |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`reset<class_AnimationTreePlayer_method_reset>` **(** **)**                                                                                                                                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_method_timescale_node_get_scale>` **(** :ref:`String<class_String>` id **)** const                                                                                        |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_method_timescale_node_set_scale>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)**                                                             |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`timeseek_node_seek<class_AnimationTreePlayer_method_timeseek_node_seek>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)**                                                                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`transition_node_delete_input<class_AnimationTreePlayer_method_transition_node_delete_input>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**                                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                              | :ref:`transition_node_get_current<class_AnimationTreePlayer_method_transition_node_get_current>` **(** :ref:`String<class_String>` id **)** const                                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                              | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_method_transition_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const                                                                          |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_method_transition_node_get_xfade_time>` **(** :ref:`String<class_String>` id **)** const                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_method_transition_node_has_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`transition_node_set_current<class_AnimationTreePlayer_method_transition_node_set_current>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**                                                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_method_transition_node_set_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_method_transition_node_set_input_count>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)**                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                               | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_method_transition_node_set_xfade_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**                                              |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _enum_AnimationTreePlayer_NodeType:

.. _class_AnimationTreePlayer_constant_NODE_OUTPUT:

.. _class_AnimationTreePlayer_constant_NODE_ANIMATION:

.. _class_AnimationTreePlayer_constant_NODE_ONESHOT:

.. _class_AnimationTreePlayer_constant_NODE_MIX:

.. _class_AnimationTreePlayer_constant_NODE_BLEND2:

.. _class_AnimationTreePlayer_constant_NODE_BLEND3:

.. _class_AnimationTreePlayer_constant_NODE_BLEND4:

.. _class_AnimationTreePlayer_constant_NODE_TIMESCALE:

.. _class_AnimationTreePlayer_constant_NODE_TIMESEEK:

.. _class_AnimationTreePlayer_constant_NODE_TRANSITION:

enum **NodeType**:

- **NODE_OUTPUT** = **0** --- Output node.

- **NODE_ANIMATION** = **1** --- Animation node.

- **NODE_ONESHOT** = **2** --- OneShot node.

- **NODE_MIX** = **3** --- Mix node.

- **NODE_BLEND2** = **4** --- Blend2 node.

- **NODE_BLEND3** = **5** --- Blend3 node.

- **NODE_BLEND4** = **6** --- Blend4 node.

- **NODE_TIMESCALE** = **7** --- TimeScale node.

- **NODE_TIMESEEK** = **8** --- TimeSeek node.

- **NODE_TRANSITION** = **9** --- Transition node.

----

.. _enum_AnimationTreePlayer_AnimationProcessMode:

.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS:

.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE:

enum **AnimationProcessMode**:

- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies.

- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process.

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

.. _class_AnimationTreePlayer_property_active:

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

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

If ``true``, the ``AnimationTreePlayer`` is able to play animations.

----

.. _class_AnimationTreePlayer_property_base_path:

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

+-----------+----------------------+
| *Default* | ``NodePath("..")``   |
+-----------+----------------------+
| *Setter*  | set_base_path(value) |
+-----------+----------------------+
| *Getter*  | get_base_path()      |
+-----------+----------------------+

The node from which to relatively access other nodes.

It accesses the bones, so it should point to the same node the :ref:`AnimationPlayer<class_AnimationPlayer>` would point its Root Node at.

----

.. _class_AnimationTreePlayer_property_master_player:

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

+-----------+--------------------------+
| *Default* | ``NodePath("")``         |
+-----------+--------------------------+
| *Setter*  | set_master_player(value) |
+-----------+--------------------------+
| *Getter*  | get_master_player()      |
+-----------+--------------------------+

The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` from which this ``AnimationTreePlayer`` binds animations to animation nodes.

Once set, :ref:`Animation<class_Animation>` nodes can be added to the ``AnimationTreePlayer``.

----

.. _class_AnimationTreePlayer_property_playback_process_mode:

- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**

+-----------+-----------------------------------+
| *Default* | ``1``                             |
+-----------+-----------------------------------+
| *Setter*  | set_animation_process_mode(value) |
+-----------+-----------------------------------+
| *Getter*  | get_animation_process_mode()      |
+-----------+-----------------------------------+

The thread in which to update animations.

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

.. _class_AnimationTreePlayer_method_add_node:

- void **add_node** **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)**

Adds a ``type`` node to the graph with name ``id``.

----

.. _class_AnimationTreePlayer_method_advance:

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

Shifts position in the animation timeline. ``delta`` is the time in seconds to shift. Events between the current frame and ``delta`` are handled.

----

.. _class_AnimationTreePlayer_method_animation_node_get_animation:

- :ref:`Animation<class_Animation>` **animation_node_get_animation** **(** :ref:`String<class_String>` id **)** const

Returns the :ref:`AnimationPlayer<class_AnimationPlayer>`'s :ref:`Animation<class_Animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``.

----

.. _class_AnimationTreePlayer_method_animation_node_get_master_animation:

- :ref:`String<class_String>` **animation_node_get_master_animation** **(** :ref:`String<class_String>` id **)** const

Returns the name of the :ref:`master_player<class_AnimationTreePlayer_property_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node.

----

.. _class_AnimationTreePlayer_method_animation_node_get_position:

- :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_String>` id **)** const

Returns the absolute playback timestamp of the animation node with name ``id``.

----

.. _class_AnimationTreePlayer_method_animation_node_set_animation:

- void **animation_node_set_animation** **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)**

Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.

----

.. _class_AnimationTreePlayer_method_animation_node_set_filter_path:

- void **animation_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**

If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.

----

.. _class_AnimationTreePlayer_method_animation_node_set_master_animation:

- void **animation_node_set_master_animation** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)**

Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the animation node ``id``. Recalculates caches.

----

.. _class_AnimationTreePlayer_method_are_nodes_connected:

- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const

Returns whether node ``id`` and ``dst_id`` are connected at the specified slot.

----

.. _class_AnimationTreePlayer_method_blend2_node_get_amount:

- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_String>` id **)** const

Returns the blend amount of a Blend2 node given its name.

----

.. _class_AnimationTreePlayer_method_blend2_node_set_amount:

- void **blend2_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**

Sets the blend amount of a Blend2 node given its name and value.

A Blend2 node blends two animations (A and B) with the amount between 0 and 1.

At 0, output is input A. Towards 1, the influence of A gets lessened, the influence of B gets raised. At 1, output is input B.

----

.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path:

- void **blend2_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**

If ``enable`` is ``true``, the Blend2 node with name ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.

----

.. _class_AnimationTreePlayer_method_blend3_node_get_amount:

- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_String>` id **)** const

Returns the blend amount of a Blend3 node given its name.

----

.. _class_AnimationTreePlayer_method_blend3_node_set_amount:

- void **blend3_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**

Sets the blend amount of a Blend3 node given its name and value.

A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1.

At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the influence of A gets raised and the influence of B+ is 0. At 0, output is input A. From 0 to 1, the influence of A gets lessened, the influence of B+ gets raised and the influence of B+ is 0. At 1, output is input B+.

----

.. _class_AnimationTreePlayer_method_blend4_node_get_amount:

- :ref:`Vector2<class_Vector2>` **blend4_node_get_amount** **(** :ref:`String<class_String>` id **)** const

Returns the blend amount of a Blend4 node given its name.

----

.. _class_AnimationTreePlayer_method_blend4_node_set_amount:

- void **blend4_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)**

Sets the blend amount of a Blend4 node given its name and value.

A Blend4 Node blends two pairs of animations.

The two pairs are blended like Blend2 and then added together.

----

.. _class_AnimationTreePlayer_method_connect_nodes:

- :ref:`Error<enum_@GlobalScope_Error>` **connect_nodes** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)**

Connects node ``id`` to ``dst_id`` at the specified input slot.

----

.. _class_AnimationTreePlayer_method_disconnect_nodes:

- void **disconnect_nodes** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)**

Disconnects nodes connected to ``id`` at the specified input slot.

----

.. _class_AnimationTreePlayer_method_get_node_list:

- :ref:`PoolStringArray<class_PoolStringArray>` **get_node_list** **(** **)**

Returns a :ref:`PoolStringArray<class_PoolStringArray>` containing the name of all nodes.

----

.. _class_AnimationTreePlayer_method_mix_node_get_amount:

- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_String>` id **)** const

Returns the mix amount of a Mix node given its name.

----

.. _class_AnimationTreePlayer_method_mix_node_set_amount:

- void **mix_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)**

Sets the mix amount of a Mix node given its name and value.

A Mix node adds input b to input a by the amount given by ratio.

----

.. _class_AnimationTreePlayer_method_node_exists:

- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_String>` node **)** const

Check if a node exists (by name).

----

.. _class_AnimationTreePlayer_method_node_get_input_count:

- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_String>` id **)** const

Returns the input count for a given node. Different types of nodes have different amount of inputs.

----

.. _class_AnimationTreePlayer_method_node_get_input_source:

- :ref:`String<class_String>` **node_get_input_source** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const

Returns the input source for a given node input.

----

.. _class_AnimationTreePlayer_method_node_get_position:

- :ref:`Vector2<class_Vector2>` **node_get_position** **(** :ref:`String<class_String>` id **)** const

Returns position of a node in the graph given its name.

----

.. _class_AnimationTreePlayer_method_node_get_type:

- :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` **node_get_type** **(** :ref:`String<class_String>` id **)** const

Gets the node type, will return from :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` enum.

----

.. _class_AnimationTreePlayer_method_node_rename:

- :ref:`Error<enum_@GlobalScope_Error>` **node_rename** **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)**

Renames a node in the graph.

----

.. _class_AnimationTreePlayer_method_node_set_position:

- void **node_set_position** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)**

Sets the position of a node in the graph given its name and position.

----

.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay:

- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_String>` id **)** const

Returns the autostart delay of a OneShot node given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay:

- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_String>` id **)** const

Returns the autostart random delay of a OneShot node given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time:

- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_String>` id **)** const

Returns the fade in time of a OneShot node given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time:

- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_String>` id **)** const

Returns the fade out time of a OneShot node given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart:

- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_String>` id **)** const

Returns whether a OneShot node will auto restart given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_is_active:

- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_String>` id **)** const

Returns whether a OneShot node is active given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart:

- void **oneshot_node_set_autorestart** **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)**

Sets the autorestart property of a OneShot node given its name and value.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay:

- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)**

Sets the autorestart delay of a OneShot node given its name and value in seconds.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay:

- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)**

Sets the autorestart random delay of a OneShot node given its name and value in seconds.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time:

- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**

Sets the fade in time of a OneShot node given its name and value in seconds.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time:

- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**

Sets the fade out time of a OneShot node given its name and value in seconds.

----

.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path:

- void **oneshot_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**

If ``enable`` is ``true``, the OneShot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.

----

.. _class_AnimationTreePlayer_method_oneshot_node_start:

- void **oneshot_node_start** **(** :ref:`String<class_String>` id **)**

Starts a OneShot node given its name.

----

.. _class_AnimationTreePlayer_method_oneshot_node_stop:

- void **oneshot_node_stop** **(** :ref:`String<class_String>` id **)**

Stops the OneShot node with name ``id``.

----

.. _class_AnimationTreePlayer_method_recompute_caches:

- void **recompute_caches** **(** **)**

Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.

----

.. _class_AnimationTreePlayer_method_remove_node:

- void **remove_node** **(** :ref:`String<class_String>` id **)**

Removes the animation node with name ``id``.

----

.. _class_AnimationTreePlayer_method_reset:

- void **reset** **(** **)**

Resets this ``AnimationTreePlayer``.

----

.. _class_AnimationTreePlayer_method_timescale_node_get_scale:

- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_String>` id **)** const

Returns the time scale value of the TimeScale node with name ``id``.

----

.. _class_AnimationTreePlayer_method_timescale_node_set_scale:

- void **timescale_node_set_scale** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)**

Sets the time scale of the TimeScale node with name ``id`` to ``scale``.

The TimeScale node is used to speed :ref:`Animation<class_Animation>`\ s up if the scale is above 1 or slow them down if it is below 1.

If applied after a blend or mix, affects all input animations to that blend or mix.

----

.. _class_AnimationTreePlayer_method_timeseek_node_seek:

- void **timeseek_node_seek** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)**

Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``.

This functions as a seek in the :ref:`Animation<class_Animation>` or the blend or mix of :ref:`Animation<class_Animation>`\ s input in it.

----

.. _class_AnimationTreePlayer_method_transition_node_delete_input:

- void **transition_node_delete_input** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**

Deletes the input at ``input_idx`` for the transition node with name ``id``.

----

.. _class_AnimationTreePlayer_method_transition_node_get_current:

- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_String>` id **)** const

Returns the index of the currently evaluated input for the transition node with name ``id``.

----

.. _class_AnimationTreePlayer_method_transition_node_get_input_count:

- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_String>` id **)** const

Returns the number of inputs for the transition node with name ``id``. You can add inputs by right-clicking on the transition node.

----

.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time:

- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_String>` id **)** const

Returns the cross fade time for the transition node with name ``id``.

----

.. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance:

- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const

Returns ``true`` if the input at ``input_idx`` on the transition node with name ``id`` is set to automatically advance to the next input upon completion.

----

.. _class_AnimationTreePlayer_method_transition_node_set_current:

- void **transition_node_set_current** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**

The transition node with name ``id`` sets its current input at ``input_idx``.

----

.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance:

- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**

The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes.

----

.. _class_AnimationTreePlayer_method_transition_node_set_input_count:

- void **transition_node_set_input_count** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)**

Resizes the number of inputs available for the transition node with name ``id``.

----

.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time:

- void **transition_node_set_xfade_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**

The transition node with name ``id`` sets its cross fade time to ``time_sec``.