mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
513 lines
47 KiB
ReStructuredText
513 lines
47 KiB
ReStructuredText
.. 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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Animation Player that uses a node graph for the blending.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_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_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_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_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_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`node_set_position<class_AnimationTreePlayer_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_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_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_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_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_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_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_AnimationTreePlayer_playback_process_mode:
|
|
|
|
- :ref:`int<class_int>` **playback_process_mode**
|
|
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **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.
|
|
- **ANIMATION_PROCESS_PHYSICS** = **0**
|
|
- **ANIMATION_PROCESS_IDLE** = **1**
|
|
|
|
Description
|
|
-----------
|
|
|
|
Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_AnimationTreePlayer_add_node:
|
|
|
|
- void **add_node** **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**
|
|
|
|
Add a node of a given type in the graph with given id.
|
|
|
|
.. _class_AnimationTreePlayer_advance:
|
|
|
|
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
|
|
|
.. _class_AnimationTreePlayer_animation_node_get_animation:
|
|
|
|
- :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns an animation given its name.
|
|
|
|
.. _class_AnimationTreePlayer_animation_node_get_master_animation:
|
|
|
|
- :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
.. _class_AnimationTreePlayer_animation_node_set_animation:
|
|
|
|
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
|
|
|
|
Set the animation for an animation node.
|
|
|
|
.. _class_AnimationTreePlayer_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 **)**
|
|
|
|
.. _class_AnimationTreePlayer_animation_node_set_master_animation:
|
|
|
|
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
|
|
|
|
.. _class_AnimationTreePlayer_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_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_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.
|
|
|
|
.. _class_AnimationTreePlayer_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 **)**
|
|
|
|
.. _class_AnimationTreePlayer_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_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.
|
|
|
|
.. _class_AnimationTreePlayer_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_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.
|
|
|
|
.. _class_AnimationTreePlayer_connect_nodes:
|
|
|
|
- :ref:`int<class_int>` **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_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_get_base_path:
|
|
|
|
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
|
|
|
.. _class_AnimationTreePlayer_get_master_player:
|
|
|
|
- :ref:`NodePath<class_nodepath>` **get_master_player** **(** **)** const
|
|
|
|
.. _class_AnimationTreePlayer_get_node_list:
|
|
|
|
- :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
|
|
|
|
Returns a PoolStringArray containing the name of all nodes.
|
|
|
|
.. _class_AnimationTreePlayer_is_active:
|
|
|
|
- :ref:`bool<class_bool>` **is_active** **(** **)** const
|
|
|
|
Returns whether this AnimationTreePlayer is active.
|
|
|
|
.. _class_AnimationTreePlayer_mix_node_get_amount:
|
|
|
|
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns mix amount of a Mix node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_mix_node_set_amount:
|
|
|
|
- void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
|
|
|
|
Sets mix amount of a Mix node given its name and value.
|
|
|
|
.. _class_AnimationTreePlayer_node_exists:
|
|
|
|
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
|
|
|
|
Check if a node exists (by name).
|
|
|
|
.. _class_AnimationTreePlayer_node_get_input_count:
|
|
|
|
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Return the input count for a given node. Different types of nodes have different amount of inputs.
|
|
|
|
.. _class_AnimationTreePlayer_node_get_input_source:
|
|
|
|
- :ref:`String<class_string>` **node_get_input_source** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const
|
|
|
|
Return the input source for a given node input.
|
|
|
|
.. _class_AnimationTreePlayer_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_node_get_type:
|
|
|
|
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Get the node type, will return from NODE\_\* enum.
|
|
|
|
.. _class_AnimationTreePlayer_node_rename:
|
|
|
|
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
|
|
|
|
Rename a node in the graph.
|
|
|
|
.. _class_AnimationTreePlayer_node_set_position:
|
|
|
|
- void **node_set_position** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)**
|
|
|
|
Sets position of a node in the graph given its name and position.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
|
|
|
|
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns autostart delay of a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
|
|
|
|
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns autostart random delay of a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time:
|
|
|
|
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns fade in time of a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time:
|
|
|
|
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns fade out time of a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_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_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_oneshot_node_set_autorestart:
|
|
|
|
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**
|
|
|
|
Sets autorestart property of a OneShot node given its name and value.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay:
|
|
|
|
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)**
|
|
|
|
Sets autorestart delay of a OneShot node given its name and value in seconds.
|
|
|
|
.. _class_AnimationTreePlayer_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 autorestart random delay of a OneShot node given its name and value in seconds.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
|
|
|
|
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
|
|
|
Sets fade in time of a OneShot node given its name and value in seconds.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
|
|
|
|
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
|
|
|
Sets fade out time of a OneShot node given its name and value in seconds.
|
|
|
|
.. _class_AnimationTreePlayer_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 **)**
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_start:
|
|
|
|
- void **oneshot_node_start** **(** :ref:`String<class_string>` id **)**
|
|
|
|
Starts a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_oneshot_node_stop:
|
|
|
|
- void **oneshot_node_stop** **(** :ref:`String<class_string>` id **)**
|
|
|
|
Stops a OneShot node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_recompute_caches:
|
|
|
|
- void **recompute_caches** **(** **)**
|
|
|
|
.. _class_AnimationTreePlayer_remove_node:
|
|
|
|
- void **remove_node** **(** :ref:`String<class_string>` id **)**
|
|
|
|
.. _class_AnimationTreePlayer_reset:
|
|
|
|
- void **reset** **(** **)**
|
|
|
|
Resets this AnimationTreePlayer.
|
|
|
|
.. _class_AnimationTreePlayer_set_active:
|
|
|
|
- void **set_active** **(** :ref:`bool<class_bool>` enabled **)**
|
|
|
|
Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active.
|
|
|
|
.. _class_AnimationTreePlayer_set_base_path:
|
|
|
|
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
|
|
|
|
Sets base path of this AnimationTreePlayer.
|
|
|
|
.. _class_AnimationTreePlayer_set_master_player:
|
|
|
|
- void **set_master_player** **(** :ref:`NodePath<class_nodepath>` nodepath **)**
|
|
|
|
.. _class_AnimationTreePlayer_timescale_node_get_scale:
|
|
|
|
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
Returns time scale value of a TimeScale node given its name.
|
|
|
|
.. _class_AnimationTreePlayer_timescale_node_set_scale:
|
|
|
|
- void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
|
|
|
|
Sets time scale value of a TimeScale node given its name and value.
|
|
|
|
.. _class_AnimationTreePlayer_timeseek_node_seek:
|
|
|
|
- void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**
|
|
|
|
Sets time seek value of a TimeSeek node given its name and value.
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_delete_input:
|
|
|
|
- void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_get_current:
|
|
|
|
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_get_input_count:
|
|
|
|
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_get_xfade_time:
|
|
|
|
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
|
|
|
|
.. _class_AnimationTreePlayer_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
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_set_current:
|
|
|
|
- void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
|
|
|
.. _class_AnimationTreePlayer_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 **)**
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_set_input_count:
|
|
|
|
- void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
|
|
|
|
.. _class_AnimationTreePlayer_transition_node_set_xfade_time:
|
|
|
|
- void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
|
|
|
|