Browse Source

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.
Michael Pobega 6 years ago
parent
commit
ffa22c9273
2 changed files with 3 additions and 3 deletions
  1. 2 2
      doc/classes/AnimationPlayer.xml
  2. 1 1
      doc/classes/AnimationTreePlayer.xml

+ 2 - 2
doc/classes/AnimationPlayer.xml

@@ -30,7 +30,7 @@
 			<argument index="0" name="delta" type="float">
 			<argument index="0" name="delta" type="float">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="animation_get_next" qualifiers="const">
 		<method name="animation_get_next" qualifiers="const">
@@ -197,7 +197,7 @@
 			<argument index="1" name="update" type="bool" default="false">
 			<argument index="1" name="update" type="bool" default="false">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="set_blend_time">
 		<method name="set_blend_time">

+ 1 - 1
doc/classes/AnimationTreePlayer.xml

@@ -29,7 +29,7 @@
 			<argument index="0" name="delta" type="float">
 			<argument index="0" name="delta" type="float">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="animation_node_get_animation" qualifiers="const">
 		<method name="animation_node_get_animation" qualifiers="const">