2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 21:18:53 +08:00
<class name= "AnimatedSprite3D" inherits= "SpriteBase3D" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-10-07 00:33:16 +08:00
2D sprite node in 3D world, that can use multiple 2D textures for animation.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2017-10-07 00:33:16 +08:00
Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2021-11-15 17:43:07 +08:00
<link title= "2D Sprite animation (also applies to 3D)" > $DOCS_URL/tutorials/2d/2d_sprite_animation.html</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
<method name= "is_playing" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
Returns [code]true[/code] if an animation is currently being played.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "play" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "anim" type= "StringName" default= "&""" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "stop" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
Stops the current animation (does not reset the frame counter).
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members >
2021-06-06 03:24:24 +08:00
<member name= "animation" type= "StringName" setter= "set_animation" getter= "get_animation" default= "&"default"" >
2017-10-07 00:33:16 +08:00
The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "frame" type= "int" setter= "set_frame" getter= "get_frame" default= "0" >
2017-10-07 00:33:16 +08:00
The displayed animation frame's index.
2017-09-13 04:42:36 +08:00
</member>
2019-07-16 02:42:47 +08:00
<member name= "frames" type= "SpriteFrames" setter= "set_sprite_frames" getter= "get_sprite_frames" >
2017-10-07 00:33:16 +08:00
The [SpriteFrames] resource containing the animation(s).
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "playing" type= "bool" setter= "_set_playing" getter= "_is_playing" default= "false" >
2018-12-20 20:46:54 +08:00
If [code]true[/code], the [member animation] is currently playing.
2017-09-13 04:42:36 +08:00
</member>
</members>
<signals >
2020-07-12 20:39:21 +08:00
<signal name= "animation_finished" >
<description >
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.
</description>
</signal>
2017-09-13 04:42:36 +08:00
<signal name= "frame_changed" >
<description >
2017-10-07 00:33:16 +08:00
Emitted when [member frame] changed.
2017-09-13 04:42:36 +08:00
</description>
</signal>
</signals>
</class>