summaryrefslogtreecommitdiff
path: root/doc/classes/SpriteFrames.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/SpriteFrames.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/SpriteFrames.xml')
-rw-r--r--doc/classes/SpriteFrames.xml46
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml
index 0d423630d4..f063a4c4c2 100644
--- a/doc/classes/SpriteFrames.xml
+++ b/doc/classes/SpriteFrames.xml
@@ -12,23 +12,23 @@
<methods>
<method name="add_animation">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
Adds a new animation to the library.
</description>
</method>
<method name="add_frame">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="frame" type="Texture2D" />
- <argument index="2" name="at_position" type="int" default="-1" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="frame" type="Texture2D" />
+ <param index="2" name="at_position" type="int" default="-1" />
<description>
Adds a frame to the given animation.
</description>
</method>
<method name="clear">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
Removes all frames from the given animation.
</description>
@@ -41,7 +41,7 @@
</method>
<method name="get_animation_loop" qualifiers="const">
<return type="bool" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
</description>
@@ -54,77 +54,77 @@
</method>
<method name="get_animation_speed" qualifiers="const">
<return type="float" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
The animation's speed in frames per second.
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="Texture2D" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="idx" type="int" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="idx" type="int" />
<description>
Returns the animation's selected frame.
</description>
</method>
<method name="get_frame_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
Returns the number of frames in the animation.
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
If [code]true[/code], the named animation exists.
</description>
</method>
<method name="remove_animation">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
<description>
Removes the given animation.
</description>
</method>
<method name="remove_frame">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="idx" type="int" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="idx" type="int" />
<description>
Removes the animation's selected frame.
</description>
</method>
<method name="rename_animation">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="newname" type="StringName" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="newname" type="StringName" />
<description>
Changes the animation's name to [code]newname[/code].
</description>
</method>
<method name="set_animation_loop">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="loop" type="bool" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="loop" type="bool" />
<description>
If [code]true[/code], the animation will loop.
</description>
</method>
<method name="set_animation_speed">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="speed" type="float" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="speed" type="float" />
<description>
The animation's speed in frames per second.
</description>
</method>
<method name="set_frame">
<return type="void" />
- <argument index="0" name="anim" type="StringName" />
- <argument index="1" name="idx" type="int" />
- <argument index="2" name="txt" type="Texture2D" />
+ <param index="0" name="anim" type="StringName" />
+ <param index="1" name="idx" type="int" />
+ <param index="2" name="txt" type="Texture2D" />
<description>
Sets the texture of the given frame.
</description>