diff options
author | Haoyu Qiu <timothyqiu32@gmail.com> | 2022-08-29 14:18:01 +0800 |
---|---|---|
committer | Haoyu Qiu <timothyqiu32@gmail.com> | 2022-08-29 14:54:57 +0800 |
commit | 385a5b44aa32319bd918c19ec9c8f375444f4802 (patch) | |
tree | b91c8d52a4d835f4831a986c43dc459ae5b1ac2d /doc/classes | |
parent | c08e84af0d52fa9bce1145ba2c22c7452b7d8997 (diff) |
Improve documentation for `get_animation()`
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/AnimationLibrary.xml | 2 | ||||
-rw-r--r-- | doc/classes/AnimationPlayer.xml | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/AnimationLibrary.xml b/doc/classes/AnimationLibrary.xml index fbbf9a3be4..75fe393dbb 100644 --- a/doc/classes/AnimationLibrary.xml +++ b/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"> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index d771206cc2..710dc55a4b 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/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"> |