Browse Source

Improve documentation for `get_animation()`

Haoyu Qiu 3 năm trước cách đây
mục cha
commit
385a5b44aa

+ 1 - 1
doc/classes/AnimationLibrary.xml

@@ -22,7 +22,7 @@
 			<return type="Animation" />
 			<param index="0" name="name" type="StringName" />
 			<description>
-				Returns the [Animation] with the key [param name], or [code]null[/code] if none is found.
+				Returns the [Animation] with the key [param name]. If the animation does not exist, [code]null[/code] is returned and an error is logged.
 			</description>
 		</method>
 		<method name="get_animation_list" qualifiers="const">

+ 1 - 1
doc/classes/AnimationPlayer.xml

@@ -75,7 +75,7 @@
 			<return type="Animation" />
 			<param index="0" name="name" type="StringName" />
 			<description>
-				Returns the [Animation] with key [param name] or [code]null[/code] if not found.
+				Returns the [Animation] with the key [param name]. If the animation does not exist, [code]null[/code] is returned and an error is logged.
 			</description>
 		</method>
 		<method name="get_animation_library" qualifiers="const">

+ 1 - 1
scene/animation/animation_player.cpp

@@ -1501,7 +1501,7 @@ bool AnimationPlayer::has_animation(const StringName &p_name) const {
 }
 
 Ref<Animation> AnimationPlayer::get_animation(const StringName &p_name) const {
-	ERR_FAIL_COND_V_MSG(!animation_set.has(p_name), Ref<Animation>(), vformat("Animation not found: %s.", p_name));
+	ERR_FAIL_COND_V_MSG(!animation_set.has(p_name), Ref<Animation>(), vformat("Animation not found: \"%s\".", p_name));
 
 	const AnimationData &data = animation_set[p_name];
 

+ 1 - 1
scene/resources/animation_library.cpp

@@ -85,7 +85,7 @@ bool AnimationLibrary::has_animation(const StringName &p_name) const {
 }
 
 Ref<Animation> AnimationLibrary::get_animation(const StringName &p_name) const {
-	ERR_FAIL_COND_V(!animations.has(p_name), Ref<Animation>());
+	ERR_FAIL_COND_V_MSG(!animations.has(p_name), Ref<Animation>(), vformat("Animation not found: \"%s\".", p_name));
 
 	return animations[p_name];
 }