godot-docs/classes/class_animationnodestatemachineplayback.rst

:github_url: hide

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

.. _class_AnimationNodeStateMachinePlayback:

AnimationNodeStateMachinePlayback
=================================

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Playback control for :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`.

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

Allows control of :ref:`AnimationTree<class_AnimationTree>` state machines created with :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`. Retrieve with ``$AnimationTree.get("parameters/playback")``.

**Example:**

::

    var state_machine = $AnimationTree.get("parameters/playback")
    state_machine.travel("some_state")

Tutorials
---------

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

Properties
----------

+-------------------------+-------------------------+------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``true`` *(parent override)* |
+-------------------------+-------------------------+------------------------------+

Methods
-------

+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`get_current_length<class_AnimationNodeStateMachinePlayback_method_get_current_length>` **(** **)** |const|               |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_method_get_current_node>` **(** **)** |const|                   |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`get_current_play_position<class_AnimationNodeStateMachinePlayback_method_get_current_play_position>` **(** **)** |const| |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>` **(** **)** |const|                     |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>` **(** **)** |const|                               |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`start<class_AnimationNodeStateMachinePlayback_method_start>` **(** :ref:`String<class_String>` node **)**                |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`stop<class_AnimationNodeStateMachinePlayback_method_stop>` **(** **)**                                                   |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`travel<class_AnimationNodeStateMachinePlayback_method_travel>` **(** :ref:`String<class_String>` to_node **)**           |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_AnimationNodeStateMachinePlayback_method_get_current_length:

- :ref:`float<class_float>` **get_current_length** **(** **)** |const|

----

.. _class_AnimationNodeStateMachinePlayback_method_get_current_node:

- :ref:`String<class_String>` **get_current_node** **(** **)** |const|

Returns the currently playing animation state.

----

.. _class_AnimationNodeStateMachinePlayback_method_get_current_play_position:

- :ref:`float<class_float>` **get_current_play_position** **(** **)** |const|

Returns the playback position within the current animation state.

----

.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:

- :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** |const|

Returns the current travel path as computed internally by the A\* algorithm.

----

.. _class_AnimationNodeStateMachinePlayback_method_is_playing:

- :ref:`bool<class_bool>` **is_playing** **(** **)** |const|

Returns ``true`` if an animation is playing.

----

.. _class_AnimationNodeStateMachinePlayback_method_start:

- void **start** **(** :ref:`String<class_String>` node **)**

Starts playing the given animation.

----

.. _class_AnimationNodeStateMachinePlayback_method_stop:

- void **stop** **(** **)**

Stops the currently playing animation.

----

.. _class_AnimationNodeStateMachinePlayback_method_travel:

- void **travel** **(** :ref:`String<class_String>` to_node **)**

Transitions from the current state to another one, following the shortest path.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`