From 57810f851cea9084e3e05372eadf284b035f5b25 Mon Sep 17 00:00:00 2001
From: Tomasz Chabora <kobewi4e@gmail.com>
Date: Sat, 22 Aug 2020 20:08:15 +0200
Subject: [PATCH] Explain editor usage of current_animation

(cherry picked from commit 70ce86ad296bed2f9cf5c2dc8e37b8866f5d251a)
---
 doc/classes/AnimationPlayer.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml
index d5f5b466347..843f47e533c 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="&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.