summaryrefslogtreecommitdiff
path: root/doc/classes/SpriteFrames.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/SpriteFrames.xml')
-rw-r--r--doc/classes/SpriteFrames.xml159
1 files changed, 159 insertions, 0 deletions
diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml
new file mode 100644
index 0000000000..1c5669b898
--- /dev/null
+++ b/doc/classes/SpriteFrames.xml
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Sprite frame library for AnimatedSprite.
+ </brief_description>
+ <description>
+ Sprite frame library for [AnimatedSprite].
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="add_animation">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="add_frame">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="frame" type="Texture">
+ </argument>
+ <argument index="2" name="atpos" type="int" default="-1">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="clear">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="clear_all">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_animation_loop" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="get_animation_speed" qualifiers="const">
+ <return type="float">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="get_frame" qualifiers="const">
+ <return type="Texture">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="idx" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="get_frame_count" qualifiers="const">
+ <return type="int">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="has_animation" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="remove_animation">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="remove_frame">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="idx" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="rename_animation">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="newname" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_animation_loop">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="loop" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_animation_speed">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="speed" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_frame">
+ <return type="void">
+ </return>
+ <argument index="0" name="anim" type="String">
+ </argument>
+ <argument index="1" name="idx" type="int">
+ </argument>
+ <argument index="2" name="txt" type="Texture">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="animations" type="Array" setter="_set_animations" getter="_get_animations">
+ </member>
+ <member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>