Explain editor usage of current_animation

(cherry picked from commit 70ce86ad29)
This commit is contained in:
Tomasz Chabora 2020-08-22 20:08:15 +02:00 committed by Rémi Verschelde
parent fdb5561e55
commit 57810f851c
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -236,7 +236,8 @@
The name of the animation to play when the scene loads.
</member>
<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation" default="&quot;&quot;">
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play].
The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See [method play] for more information on playing animations.
[b]Note[/b]: while this property appears in the inspector, it's not meant to be edited and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see [Animation].
</member>
<member name="current_animation_length" type="float" setter="" getter="get_current_animation_length">
The length (in seconds) of the currently being played animation.