godot/doc/classes/SpriteFrames.xml
Rémi Verschelde f5836b40d4
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00

141 lines
4.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpriteFrames" inherits="Resource" version="3.4">
<brief_description>
Sprite frame library for AnimatedSprite.
</brief_description>
<description>
Sprite frame library for [AnimatedSprite]. Contains frames and animation data for playback.
[b]Note:[/b] You can associate a set of normal maps by creating additional [SpriteFrames] resources with a [code]_normal[/code] suffix. For example, having 2 [SpriteFrames] resources [code]run[/code] and [code]run_normal[/code] will make it so the [code]run[/code] animation uses the normal map.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_animation">
<return type="void" />
<argument index="0" name="anim" type="String" />
<description>
Adds a new animation to the library.
</description>
</method>
<method name="add_frame">
<return type="void" />
<argument index="0" name="anim" type="String" />
<argument index="1" name="frame" type="Texture" />
<argument 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="String" />
<description>
Removes all frames from the given animation.
</description>
</method>
<method name="clear_all">
<return type="void" />
<description>
Removes all animations. A "default" animation will be created.
</description>
</method>
<method name="get_animation_loop" qualifiers="const">
<return type="bool" />
<argument index="0" name="anim" type="String" />
<description>
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
</description>
</method>
<method name="get_animation_names" qualifiers="const">
<return type="PoolStringArray" />
<description>
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
</description>
</method>
<method name="get_animation_speed" qualifiers="const">
<return type="float" />
<argument index="0" name="anim" type="String" />
<description>
The animation's speed in frames per second.
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="Texture" />
<argument index="0" name="anim" type="String" />
<argument 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="String" />
<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="String" />
<description>
If [code]true[/code], the named animation exists.
</description>
</method>
<method name="remove_animation">
<return type="void" />
<argument index="0" name="anim" type="String" />
<description>
Removes the given animation.
</description>
</method>
<method name="remove_frame">
<return type="void" />
<argument index="0" name="anim" type="String" />
<argument 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="String" />
<argument index="1" name="newname" type="String" />
<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="String" />
<argument 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="String" />
<argument 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="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="txt" type="Texture" />
<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>
<constants>
</constants>
</class>