Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: da55f95642
Branches Tags
godot-docs
/
classes
/
class_animationtreeplayer.rst

class_animationtreeplayer.rst 46 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_AnimationTreePlayer:
    6. 

  6. 

  7. AnimationTreePlayer
    8. 

  8. ===================
    9. 

  9. 

  10. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Animation Player that uses a node graph for the blending.
    18. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | void                                           | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**                                                                                                  |
    24. 

  24. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                                           | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)**                                                                                                                               |
    26. 

  26. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Animation<class_animation>`              | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const                                                                                |
    28. 

  28. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`String<class_string>`                    | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const                                                                  |
    30. 

  30. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                                           | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**                                         |
    32. 

  32. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | void                                           | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**            |
    34. 

  34. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | void                                           | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**                                    |
    36. 

  36. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`bool<class_bool>`                        | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const                         |
    38. 

  38. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`float<class_float>`                      | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const                                                                                            |
    40. 

  40. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | void                                           | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**                                                                 |
    42. 

  42. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                                           | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**                  |
    44. 

  44. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`float<class_float>`                      | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const                                                                                            |
    46. 

  46. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                                           | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**                                                                 |
    48. 

  48. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`Vector2<class_vector2>`                  | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const                                                                                            |
    50. 

  50. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | void                                           | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**                                                             |
    52. 

  52. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`int<class_int>`                          | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**                                           |
    54. 

  54. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | void                                           | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**                                                                         |
    56. 

  56. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`PoolStringArray<class_poolstringarray>`  | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)**                                                                                                                                                   |
    58. 

  58. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`float<class_float>`                      | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const                                                                                                  |
    60. 

  60. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. | void                                           | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**                                                                       |
    62. 

  62. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. | :ref:`bool<class_bool>`                        | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const                                                                                                                |
    64. 

  64. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65. | :ref:`int<class_int>`                          | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const                                                                                                |
    66. 

  66. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. | :ref:`String<class_string>`                    | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const                                                                   |
    68. 

  68. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69. | :ref:`Vector2<class_vector2>`                  | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const                                                                                                      |
    70. 

  70. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71. | :ref:`int<class_int>`                          | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const                                                                                                              |
    72. 

  72. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73. | :ref:`int<class_int>`                          | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**                                                                                |
    74. 

  74. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75. | void                                           | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)**                                                             |
    76. 

  76. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77. | :ref:`float<class_float>`                      | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const                                                                    |
    78. 

  78. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79. | :ref:`float<class_float>`                      | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const                                                      |
    80. 

  80. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81. | :ref:`float<class_float>`                      | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const                                                                                |
    82. 

  82. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    83. 

  83. | :ref:`float<class_float>`                      | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const                                                                              |
    84. 

  84. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    85. 

  85. | :ref:`bool<class_bool>`                        | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const                                                                                |
    86. 

  86. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    87. 

  87. | :ref:`bool<class_bool>`                        | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const                                                                                            |
    88. 

  88. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    89. 

  89. | void                                           | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**                                                      |
    90. 

  90. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    91. 

  91. | void                                           | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)**                                     |
    92. 

  92. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    93. 

  93. | void                                           | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)**                        |
    94. 

  94. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    95. 

  95. | void                                           | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**                                                  |
    96. 

  96. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    97. 

  97. | void                                           | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**                                                |
    98. 

  98. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    99. 

  99. | void                                           | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**                |
    100. 

  100. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    101. 

  101. | void                                           | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)**                                                                                                          |
    102. 

  102. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    103. 

  103. | void                                           | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)**                                                                                                            |
    104. 

  104. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    105. 

  105. | void                                           | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)**                                                                                                                                             |
    106. 

  106. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    107. 

  107. | void                                           | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)**                                                                                                                        |
    108. 

  108. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    109. 

  109. | void                                           | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)**                                                                                                                                                                   |
    110. 

  110. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    111. 

  111. | :ref:`float<class_float>`                      | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const                                                                                        |
    112. 

  112. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    113. 

  113. | void                                           | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**                                                             |
    114. 

  114. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    115. 

  115. | void                                           | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**                                                                       |
    116. 

  116. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    117. 

  117. | void                                           | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**                                                     |
    118. 

  118. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    119. 

  119. | :ref:`int<class_int>`                          | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const                                                                                  |
    120. 

  120. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    121. 

  121. | :ref:`int<class_int>`                          | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const                                                                          |
    122. 

  122. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    123. 

  123. | :ref:`float<class_float>`                      | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const                                                                            |
    124. 

  124. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    125. 

  125. | :ref:`bool<class_bool>`                        | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const                           |
    126. 

  126. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    127. 

  127. | void                                           | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**                                                       |
    128. 

  128. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    129. 

  129. | void                                           | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
    130. 

  130. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    131. 

  131. | void                                           | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**                                                   |
    132. 

  132. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    133. 

  133. | void                                           | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**                                              |
    134. 

  134. +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    135. 

  135. 

  136. Member Variables
    137. 

  137. ----------------
    138. 

  138. 

  139.   .. _class_AnimationTreePlayer_active:
    140. 

  140. 

  141. - :ref:`bool<class_bool>` **active** - If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``.
    142. 

  142. 

  143.   .. _class_AnimationTreePlayer_base_path:
    144. 

  144. 

  145. - :ref:`NodePath<class_nodepath>` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``.
    146. 

  146. 

  147.   .. _class_AnimationTreePlayer_master_player:
    148. 

  148. 

  149. - :ref:`NodePath<class_nodepath>` **master_player** - The path to the :ref:`AnimationPlayer<class_animationplayer>` from which this ``AnimationTreePlayer`` binds animations to animation nodes.
    150. 

  150. 

  151.   .. _class_AnimationTreePlayer_playback_process_mode:
    152. 

  152. 

  153. - :ref:`int<class_int>` **playback_process_mode** - The thread in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
    154. 

  154. 

  155. 

  156. Numeric Constants
    157. 

  157. -----------------
    158. 

  158. 

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

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

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

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

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

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

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

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

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

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

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

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

  171. 

  172. Description
    173. 

  173. -----------
    174. 

  174. 

  175. 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.
    176. 

  176. 

  177. Member Function Description
    178. 

  178. ---------------------------
    179. 

  179. 

  180. .. _class_AnimationTreePlayer_add_node:
    181. 

  181. 

  182. - void **add_node** **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**
    183. 

  183. 

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

  185. 

  186. .. _class_AnimationTreePlayer_advance:
    187. 

  187. 

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

  189. 

  190. Shifts position in the animation timeline. Delta is the time in seconds to shift.
    191. 

  191. 

  192. .. _class_AnimationTreePlayer_animation_node_get_animation:
    193. 

  193. 

  194. - :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
    195. 

  195. 

  196. Returns the :ref:`AnimationPlayer<class_animationplayer>`'s animation bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
    197. 

  197. 

  198. .. _class_AnimationTreePlayer_animation_node_get_master_animation:
    199. 

  199. 

  200. - :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
    201. 

  201. 

  202. Returns the name of the :ref:`master_player<class_AnimationTreePlayer_master_player>`'s animation bound to this animation node.
    203. 

  203. 

  204. .. _class_AnimationTreePlayer_animation_node_set_animation:
    205. 

  205. 

  206. - void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
    207. 

  207. 

  208. Binds a new animation from the :ref:`master_player<class_AnimationTreePlayer_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
    209. 

  209. 

  210. .. _class_AnimationTreePlayer_animation_node_set_filter_path:
    211. 

  211. 

  212. - void **animation_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
    213. 

  213. 

  214. 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.
    215. 

  215. 

  216. .. _class_AnimationTreePlayer_animation_node_set_master_animation:
    217. 

  217. 

  218. - void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
    219. 

  219. 

  220. Binds the animation named ``source`` from :ref:`master_player<class_AnimationTreePlayer_master_player>` to the animation node ``id``. Recalculates caches.
    221. 

  221. 

  222. .. _class_AnimationTreePlayer_are_nodes_connected:
    223. 

  223. 

  224. - :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
    225. 

  225. 

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

  227. 

  228. .. _class_AnimationTreePlayer_blend2_node_get_amount:
    229. 

  229. 

  230. - :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
    231. 

  231. 

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

  233. 

  234. .. _class_AnimationTreePlayer_blend2_node_set_amount:
    235. 

  235. 

  236. - void **blend2_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
    237. 

  237. 

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

  239. 

  240. .. _class_AnimationTreePlayer_blend2_node_set_filter_path:
    241. 

  241. 

  242. - void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
    243. 

  243. 

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

  245. 

  246. .. _class_AnimationTreePlayer_blend3_node_get_amount:
    247. 

  247. 

  248. - :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_string>` id **)** const
    249. 

  249. 

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

  251. 

  252. .. _class_AnimationTreePlayer_blend3_node_set_amount:
    253. 

  253. 

  254. - void **blend3_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
    255. 

  255. 

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

  257. 

  258. .. _class_AnimationTreePlayer_blend4_node_get_amount:
    259. 

  259. 

  260. - :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
    261. 

  261. 

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

  263. 

  264. .. _class_AnimationTreePlayer_blend4_node_set_amount:
    265. 

  265. 

  266. - void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
    267. 

  267. 

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

  269. 

  270. .. _class_AnimationTreePlayer_connect_nodes:
    271. 

  271. 

  272. - :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
    273. 

  273. 

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

  275. 

  276. .. _class_AnimationTreePlayer_disconnect_nodes:
    277. 

  277. 

  278. - void **disconnect_nodes** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
    279. 

  279. 

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

  281. 

  282. .. _class_AnimationTreePlayer_get_node_list:
    283. 

  283. 

  284. - :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
    285. 

  285. 

  286. Returns a PoolStringArray containing the name of all nodes.
    287. 

  287. 

  288. .. _class_AnimationTreePlayer_mix_node_get_amount:
    289. 

  289. 

  290. - :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
    291. 

  291. 

  292. Returns mix amount of a Mix node given its name.
    293. 

  293. 

  294. .. _class_AnimationTreePlayer_mix_node_set_amount:
    295. 

  295. 

  296. - void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
    297. 

  297. 

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

  299. 

  300. .. _class_AnimationTreePlayer_node_exists:
    301. 

  301. 

  302. - :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
    303. 

  303. 

  304. Check if a node exists (by name).
    305. 

  305. 

  306. .. _class_AnimationTreePlayer_node_get_input_count:
    307. 

  307. 

  308. - :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_string>` id **)** const
    309. 

  309. 

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

  311. 

  312. .. _class_AnimationTreePlayer_node_get_input_source:
    313. 

  313. 

  314. - :ref:`String<class_string>` **node_get_input_source** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const
    315. 

  315. 

  316. Return the input source for a given node input.
    317. 

  317. 

  318. .. _class_AnimationTreePlayer_node_get_position:
    319. 

  319. 

  320. - :ref:`Vector2<class_vector2>` **node_get_position** **(** :ref:`String<class_string>` id **)** const
    321. 

  321. 

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

  323. 

  324. .. _class_AnimationTreePlayer_node_get_type:
    325. 

  325. 

  326. - :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
    327. 

  327. 

  328. Get the node type, will return from NODE\_\* enum.
    329. 

  329. 

  330. .. _class_AnimationTreePlayer_node_rename:
    331. 

  331. 

  332. - :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
    333. 

  333. 

  334. Rename a node in the graph.
    335. 

  335. 

  336. .. _class_AnimationTreePlayer_node_set_position:
    337. 

  337. 

  338. - void **node_set_position** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)**
    339. 

  339. 

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

  341. 

  342. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
    343. 

  343. 

  344. - :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
    345. 

  345. 

  346. Returns autostart delay of a OneShot node given its name.
    347. 

  347. 

  348. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
    349. 

  349. 

  350. - :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
    351. 

  351. 

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

  353. 

  354. .. _class_AnimationTreePlayer_oneshot_node_get_fadein_time:
    355. 

  355. 

  356. - :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_string>` id **)** const
    357. 

  357. 

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

  359. 

  360. .. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time:
    361. 

  361. 

  362. - :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_string>` id **)** const
    363. 

  363. 

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

  365. 

  366. .. _class_AnimationTreePlayer_oneshot_node_has_autorestart:
    367. 

  367. 

  368. - :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_string>` id **)** const
    369. 

  369. 

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

  371. 

  372. .. _class_AnimationTreePlayer_oneshot_node_is_active:
    373. 

  373. 

  374. - :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_string>` id **)** const
    375. 

  375. 

  376. Returns whether a OneShot node is active given its name.
    377. 

  377. 

  378. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart:
    379. 

  379. 

  380. - void **oneshot_node_set_autorestart** **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**
    381. 

  381. 

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

  383. 

  384. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay:
    385. 

  385. 

  386. - void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)**
    387. 

  387. 

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

  389. 

  390. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay:
    391. 

  391. 

  392. - void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)**
    393. 

  393. 

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

  395. 

  396. .. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
    397. 

  397. 

  398. - void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
    399. 

  399. 

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

  401. 

  402. .. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
    403. 

  403. 

  404. - void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
    405. 

  405. 

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

  407. 

  408. .. _class_AnimationTreePlayer_oneshot_node_set_filter_path:
    409. 

  409. 

  410. - void **oneshot_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
    411. 

  411. 

  412. 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.
    413. 

  413. 

  414. .. _class_AnimationTreePlayer_oneshot_node_start:
    415. 

  415. 

  416. - void **oneshot_node_start** **(** :ref:`String<class_string>` id **)**
    417. 

  417. 

  418. Starts a OneShot node given its name.
    419. 

  419. 

  420. .. _class_AnimationTreePlayer_oneshot_node_stop:
    421. 

  421. 

  422. - void **oneshot_node_stop** **(** :ref:`String<class_string>` id **)**
    423. 

  423. 

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

  425. 

  426. .. _class_AnimationTreePlayer_recompute_caches:
    427. 

  427. 

  428. - void **recompute_caches** **(** **)**
    429. 

  429. 

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

  431. 

  432. .. _class_AnimationTreePlayer_remove_node:
    433. 

  433. 

  434. - void **remove_node** **(** :ref:`String<class_string>` id **)**
    435. 

  435. 

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

  437. 

  438. .. _class_AnimationTreePlayer_reset:
    439. 

  439. 

  440. - void **reset** **(** **)**
    441. 

  441. 

  442. Resets this AnimationTreePlayer.
    443. 

  443. 

  444. .. _class_AnimationTreePlayer_timescale_node_get_scale:
    445. 

  445. 

  446. - :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
    447. 

  447. 

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

  449. 

  450. .. _class_AnimationTreePlayer_timescale_node_set_scale:
    451. 

  451. 

  452. - void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
    453. 

  453. 

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

  455. 

  456. .. _class_AnimationTreePlayer_timeseek_node_seek:
    457. 

  457. 

  458. - void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**
    459. 

  459. 

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

  461. 

  462. .. _class_AnimationTreePlayer_transition_node_delete_input:
    463. 

  463. 

  464. - void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
    465. 

  465. 

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

  467. 

  468. .. _class_AnimationTreePlayer_transition_node_get_current:
    469. 

  469. 

  470. - :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
    471. 

  471. 

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

  473. 

  474. .. _class_AnimationTreePlayer_transition_node_get_input_count:
    475. 

  475. 

  476. - :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
    477. 

  477. 

  478. Returns the number of inputs for the transition node with name ``id``.
    479. 

  479. 

  480. .. _class_AnimationTreePlayer_transition_node_get_xfade_time:
    481. 

  481. 

  482. - :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
    483. 

  483. 

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

  485. 

  486. .. _class_AnimationTreePlayer_transition_node_has_input_auto_advance:
    487. 

  487. 

  488. - :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const
    489. 

  489. 

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

  491. 

  492. .. _class_AnimationTreePlayer_transition_node_set_current:
    493. 

  493. 

  494. - void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
    495. 

  495. 

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

  497. 

  498. .. _class_AnimationTreePlayer_transition_node_set_input_auto_advance:
    499. 

  499. 

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

  501. 

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

  503. 

  504. .. _class_AnimationTreePlayer_transition_node_set_input_count:
    505. 

  505. 

  506. - void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
    507. 

  507. 

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

  509. 

  510. .. _class_AnimationTreePlayer_transition_node_set_xfade_time:
    511. 

  511. 

  512. - void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
    513. 

  513. 

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

  515. 

  516.