b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
138 lines
5 KiB
XML
138 lines
5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="SpriteFrames" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Sprite frame library for AnimatedSprite2D and AnimatedSprite3D.
|
|
</brief_description>
|
|
<description>
|
|
Sprite frame library for an [AnimatedSprite2D] or [AnimatedSprite3D] node. Contains frames and animation data for playback.
|
|
[b]Note:[/b] You can associate a set of normal or specular maps by creating additional [SpriteFrames] resources with a [code]_normal[/code] or [code]_specular[/code] suffix. For example, having 3 [SpriteFrames] resources [code]run[/code], [code]run_normal[/code], and [code]run_specular[/code] will make it so the [code]run[/code] animation uses normal and specular maps.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_animation">
|
|
<return type="void" />
|
|
<argument 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" />
|
|
<description>
|
|
Adds a frame to the given animation.
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void" />
|
|
<argument index="0" name="anim" type="StringName" />
|
|
<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="StringName" />
|
|
<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="PackedStringArray" />
|
|
<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="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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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" />
|
|
<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>
|