Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/doc/classes/AnimationNodeTimeSeek.xml
10277 views
1
<?xml version="1.0" encoding="UTF-8" ?>
2
<class name="AnimationNodeTimeSeek" inherits="AnimationNode" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
3
<brief_description>
4
A time-seeking animation node used in [AnimationTree].
5
</brief_description>
6
<description>
7
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 [Animation] from the start or a certain playback position inside the [AnimationNodeBlendTree].
8
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 [code]seek_request[/code] value to [code]-1.0[/code].
9
[codeblocks]
10
[gdscript]
11
# Play child animation from the start.
12
animation_tree.set("parameters/TimeSeek/seek_request", 0.0)
13
# Alternative syntax (same result as above).
14
animation_tree["parameters/TimeSeek/seek_request"] = 0.0
15
16
# Play child animation from 12 second timestamp.
17
animation_tree.set("parameters/TimeSeek/seek_request", 12.0)
18
# Alternative syntax (same result as above).
19
animation_tree["parameters/TimeSeek/seek_request"] = 12.0
20
[/gdscript]
21
[csharp]
22
// Play child animation from the start.
23
animationTree.Set("parameters/TimeSeek/seek_request", 0.0);
24
25
// Play child animation from 12 second timestamp.
26
animationTree.Set("parameters/TimeSeek/seek_request", 12.0);
27
[/csharp]
28
[/codeblocks]
29
</description>
30
<tutorials>
31
<link title="Using AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
32
</tutorials>
33
<members>
34
<member name="explicit_elapse" type="bool" setter="set_explicit_elapse" getter="is_explicit_elapse" default="true">
35
If [code]true[/code], some processes are executed to handle keys between seeks, such as calculating root motion and finding the nearest discrete key.
36
</member>
37
</members>
38
</class>
39
40