Browse Source

Document AnimationNodeTimeSeek with clarified usage and code example

Document AnimationNodeTimeSeek with clarified usage and code example

(cherry picked from commit 35c9192689216e61c7425a8ab962a0fe4dfdf58d)
smix8 4 years ago
parent
commit
595a1edd3b
1 changed files with 12 additions and 1 deletions
  1. 12 1
      doc/classes/AnimationNodeTimeSeek.xml

+ 12 - 1
doc/classes/AnimationNodeTimeSeek.xml

@@ -4,7 +4,18 @@
 		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 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 [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>