summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-05-15 09:32:33 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-05-15 09:32:33 +0200
commit51a1bd7c08b75a0c818a55c8c0e978d73e4938d9 (patch)
treec4e5bfe8bbfeb6fcd57d6c57b0bfbcc3433fbb98
parentfb10f45efe52e330496e325b6b7efd0e52f769b0 (diff)
parent27ccb529094ecd5e89669df10e1c6603c69e9a9d (diff)
downloadredot-engine-51a1bd7c08b75a0c818a55c8c0e978d73e4938d9.tar.gz
Merge pull request #75869 from aaronfranke/anim-play-end-doc
Elaborate on the from_end option in AnimationPlayer.play() documentation
-rw-r--r--doc/classes/AnimationPlayer.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml
index 94451e7c30..f06731c376 100644
--- a/doc/classes/AnimationPlayer.xml
+++ b/doc/classes/AnimationPlayer.xml
@@ -163,7 +163,8 @@
<param index="2" name="custom_speed" type="float" default="1.0" />
<param index="3" name="from_end" type="bool" default="false" />
<description>
- Plays the animation with key [param name]. Custom blend times and speed can be set. If [param custom_speed] is negative and [param from_end] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]).
+ Plays the animation with key [param name]. Custom blend times and speed can be set.
+ The [param from_end] option only affects when switching to a new animation track, or if the same track but at the start or end. It does not affect resuming playback that was paused in the middle of an animation. If [param custom_speed] is negative and [param from_end] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]).
The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [param name], or with no [param name] parameter, the assigned animation will resume playing if it was paused.
[b]Note:[/b] The animation will be updated the next time the [AnimationPlayer] is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call [code]advance(0)[/code].
</description>