diff options
Diffstat (limited to 'doc/classes/SpriteFrames.xml')
| -rw-r--r-- | doc/classes/SpriteFrames.xml | 53 |
1 files changed, 24 insertions, 29 deletions
diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index b0d1e1efcf..e9721495dd 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,85 +54,80 @@ </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]. + Changes the animation's name to [param newname]. </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> </method> </methods> - <members> - <member name="frames" type="Array" setter="_set_frames" getter="_get_frames"> - Compatibility property, always equals to an empty array. - </member> - </members> </class> |