595a1edd3b
Document AnimationNodeTimeSeek with clarified usage and code example
(cherry picked from commit 35c9192689)
28 lines
1.3 KiB
XML
28 lines
1.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AnimationNodeTimeSeek" inherits="AnimationNode" version="3.3">
|
|
<brief_description>
|
|
A time-seeking animation node to be used with [AnimationTree].
|
|
</brief_description>
|
|
<description>
|
|
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 [code]seek_position[/code] value to [code]-1.0[/code].
|
|
[codeblock]
|
|
# Play child animation from the start.
|
|
animation_tree.set("parameters/Seek/seek_position", 0.0)
|
|
# Alternative syntax (same result as above).
|
|
animation_tree["parameters/Seek/seek_position"] = 0.0
|
|
|
|
# Play child animation from 12 second timestamp.
|
|
animation_tree.set("parameters/Seek/seek_position", 12.0)
|
|
# Alternative syntax (same result as above).
|
|
animation_tree["parameters/Seek/seek_position"] = 12.0
|
|
[/codeblock]
|
|
</description>
|
|
<tutorials>
|
|
<link>https://docs.godotengine.org/en/3.3/tutorials/animation/animation_tree.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|