godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc AnimationNodeTimeSeek clarify usage and code example

Browse Source 
doc AnimationNodeTimeSeek clarify usage and code example

(cherry picked from commit 274a98b410)
This commit is contained in:
smix8
2021-04-17 19:10:35 +02:00
committed by Rémi Verschelde
parent c8e3b8417d
commit 0f3b43de49
1 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
tutorials/animation/animation_tree.rst
View File

@@ -96,7 +96,30 @@ This node will execute a sub-animation and return once it finishes. Blend times
Seek
^^^^
This node can be used to cause a seek command to happen to any sub-children of the graph. After setting the time, this value returns to -1.
This node can be used to cause a seek command to happen to any sub-children of the animation graph. Use this node type to play an ``Animation`` from the start or a certain playback position inside the ``AnimationNodeBlendTree``.
After setting the time and changing the animation playback, the seek node automatically goes into sleep mode on the next process frame by setting its ``seek_position`` value to ``-1.0``.
.. tabs::
.. code-tab:: gdscript GDScript
# Play child animation from the start.
anim_tree.set("parameters/Seek/seek_position", 0.0)
# Alternative syntax (same result as above).
anim_tree["parameters/Seek/seek_position"] = 0.0
# Play child animation from 12 second timestamp.
anim_tree.set("parameters/Seek/seek_position", 12.0)
# Alternative syntax (same result as above).
anim_tree["parameters/Seek/seek_position"] = 12.0
.. code-tab:: csharp
// Play child animation from the start.
animTree.Set("parameters/Seek/seek_position", 0.0);
// Play child animation from 12 second timestamp.
animTree.Set("parameters/Seek/seek_position", 12.0);
TimeScale
^^^^^^^^^