diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-08-31 13:24:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-31 13:24:37 +0200 |
| commit | fbb2e60783960806454c16759dd2308afd17020e (patch) | |
| tree | 6387c895b5d49ad209d8a87f056b1b3d2c6b214c | |
| parent | df333bcc66eefd9eea252dabdf88298ba48eb4f5 (diff) | |
| parent | 70ce86ad296bed2f9cf5c2dc8e37b8866f5d251a (diff) | |
Merge pull request #41457 from KoBeWi/ca
Explain editor usage of current_animation
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 6267a5a0a9..aaa48a3117 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -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=""""> - 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. |