godot/doc/classes/AnimationNodeTimeSeek.xml
smix8 35c9192689 Document AnimationNodeTimeSeek with clarified usage and code example
Document AnimationNodeTimeSeek with clarified usage and code example
2021-04-17 21:36:48 +02:00

37 lines
1.6 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTimeSeek" inherits="AnimationNode" version="4.0">
<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].
[codeblocks]
[gdscript]
# 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
[/gdscript]
[csharp]
// Play child animation from the start.
animationTree.Set("parameters/Seek/seek_position", 0.0);
// Play child animation from 12 second timestamp.
animationTree.Set("parameters/Seek/seek_position", 12.0);
[/csharp]
[/codeblocks]
</description>
<tutorials>
<link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>