Skip to content

Latest commit

 

History

History
99 lines (62 loc) · 3.95 KB

class_animationnodetimeseek.rst

File metadata and controls

99 lines (62 loc) · 3.95 KB
github_url:hide

AnimationNodeTimeSeek

Inherits: :ref:`AnimationNode<class_AnimationNode>` < :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`

A time-seeking animation node used in :ref:`AnimationTree<class_AnimationTree>`.

.. rst-class:: classref-introduction-group

Description

This animation node can be used to cause a seek command to happen to any sub-children of the animation graph. Use to play an :ref:`Animation<class_Animation>` from the start or a certain playback position inside the :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.

After setting the time and changing the animation playback, the time seek node automatically goes into sleep mode on the next process frame by setting its seek_request value to -1.0.

.. tabs::

 .. code-tab:: gdscript

    # Play child animation from the start.
    animation_tree.set("parameters/TimeSeek/seek_request", 0.0)
    # Alternative syntax (same result as above).
    animation_tree["parameters/TimeSeek/seek_request"] = 0.0

    # Play child animation from 12 second timestamp.
    animation_tree.set("parameters/TimeSeek/seek_request", 12.0)
    # Alternative syntax (same result as above).
    animation_tree["parameters/TimeSeek/seek_request"] = 12.0

 .. code-tab:: csharp

    // Play child animation from the start.
    animationTree.Set("parameters/TimeSeek/seek_request", 0.0);

    // Play child animation from 12 second timestamp.
    animationTree.Set("parameters/TimeSeek/seek_request", 12.0);



.. rst-class:: classref-introduction-group

Tutorials

.. rst-class:: classref-reftable-group

Properties

:ref:`bool<class_bool>` :ref:`explicit_elapse<class_AnimationNodeTimeSeek_property_explicit_elapse>` true
.. rst-class:: classref-section-separator


.. rst-class:: classref-descriptions-group

Property Descriptions

.. rst-class:: classref-property

:ref:`bool<class_bool>` explicit_elapse = true :ref:`🔗<class_AnimationNodeTimeSeek_property_explicit_elapse>`

.. rst-class:: classref-property-setget

If true, some processes are executed to handle keys between seeks, such as calculating root motion and finding the nearest discrete key.