summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMichael Pobega <pobega@gmail.com>2019-02-27 09:15:35 -0500
committerMichael Pobega <pobega@gmail.com>2019-02-27 15:34:23 -0500
commitffa22c9273e41c3f809bb52e2c1244e00c707bc5 (patch)
tree41ce17c16a720d1ed88a343f9421ad1b5455a2ff /doc/classes
parenteb2b9b88a965ee4b2647680d93bb931626376597 (diff)
Elaborate AnimationPlayer manual advancing
Elaborate the difference between AnimationPlayer::advance and AnimationPlayer::seek, specifically how intermediary events are handled for each. From the docs it is unclear that AnimationPlayer::advance is more of a 'fast-forward', playing each event (including function calls) between the two points.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/AnimationPlayer.xml4
-rw-r--r--doc/classes/AnimationTreePlayer.xml2
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml
index 9d68102952..21aba282ee 100644
--- a/doc/classes/AnimationPlayer.xml
+++ b/doc/classes/AnimationPlayer.xml
@@ -30,7 +30,7 @@
<argument index="0" name="delta" type="float">
</argument>
<description>
- Shifts position in the animation timeline. Delta is the time in seconds to shift.
+ Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
</description>
</method>
<method name="animation_get_next" qualifiers="const">
@@ -197,7 +197,7 @@
<argument index="1" name="update" type="bool" default="false">
</argument>
<description>
- Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time.
+ Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped.
</description>
</method>
<method name="set_blend_time">
diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml
index b0b58fc7bd..cfec75bc3a 100644
--- a/doc/classes/AnimationTreePlayer.xml
+++ b/doc/classes/AnimationTreePlayer.xml
@@ -29,7 +29,7 @@
<argument index="0" name="delta" type="float">
</argument>
<description>
- Shifts position in the animation timeline. Delta is the time in seconds to shift.
+ Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
</description>
</method>
<method name="animation_node_get_animation" qualifiers="const">