2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-19 09:46:33 +00:00
<class name= "AnimatedSprite" inherits= "Node2D" category= "Core" version= "3.1-dev" >
2017-09-12 20:42:36 +00:00
<brief_description >
Sprite node that can use multiple textures for animation.
</brief_description>
<description >
2017-10-06 16:33:16 +00:00
Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "is_playing" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
Return true if an animation if currently being played.
</description>
</method>
<method name= "play" >
<return type= "void" >
</return>
<argument index= "0" name= "anim" type= "String" default= """" >
</argument>
<description >
Play the animation set in parameter. If no parameter is provided, the current animation is played.
</description>
</method>
<method name= "stop" >
<return type= "void" >
</return>
<description >
Stop the current animation (does not reset the frame counter).
</description>
</method>
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "animation" type= "String" setter= "set_animation" getter= "get_animation" >
2017-10-06 16:33:16 +00:00
The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "centered" type= "bool" setter= "set_centered" getter= "is_centered" >
2017-09-27 05:56:16 +00:00
If [code]true[/code] texture will be centered. Default value: [code]true[/code].
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "flip_h" type= "bool" setter= "set_flip_h" getter= "is_flipped_h" >
2017-09-27 05:56:16 +00:00
If [code]true[/code] texture is flipped horizontally. Default value: [code]false[/code].
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "flip_v" type= "bool" setter= "set_flip_v" getter= "is_flipped_v" >
2017-09-27 05:56:16 +00:00
If [code]true[/code] texture is flipped vertically. Default value: [code]false[/code].
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "frame" type= "int" setter= "set_frame" getter= "get_frame" >
2017-10-06 16:33:16 +00:00
The displayed animation frame's index.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "frames" type= "SpriteFrames" setter= "set_sprite_frames" getter= "get_sprite_frames" >
2017-09-27 05:56:16 +00:00
The [SpriteFrames] resource containing the animation(s).
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "offset" type= "Vector2" setter= "set_offset" getter= "get_offset" >
2017-09-27 05:56:16 +00:00
The texture's drawing offset.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "playing" type= "bool" setter= "_set_playing" getter= "_is_playing" >
2017-10-06 16:33:16 +00:00
If [code]true[/code] the [member animation] is currently playing.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals >
<signal name= "animation_finished" >
<description >
2017-09-27 05:56:16 +00:00
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name= "frame_changed" >
<description >
2017-10-06 16:33:16 +00:00
Emitted when [member frame] changed.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants >
</constants>
</class>