:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimatedSprite.xml. .. _class_AnimatedSprite: AnimatedSprite ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Sprite node that contains multiple textures as frames to play for animation. .. rst-class:: classref-introduction-group Description ----------- **AnimatedSprite** is similar to the :ref:`Sprite` node, except it carries multiple textures as animation frames. Animations are created using a :ref:`SpriteFrames` resource, which allows you to import image files (or a folder containing said files) to provide the animation frames for the sprite. The :ref:`SpriteFrames` resource can be configured in the editor via the SpriteFrames bottom panel. \ **Note:** You can associate a set of normal maps by creating additional animations with a ``_normal`` suffix. For example, having 2 animations ``run`` and ``run_normal`` will make it so the ``run`` animation uses the normal map. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`2D Sprite animation <../tutorials/2d/2d_sprite_animation>` - `2D Dodge The Creeps Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`String` | :ref:`animation` | ``"default"`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`centered` | ``true`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`int` | :ref:`frame` | ``0`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`SpriteFrames` | :ref:`frames` | | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`playing` | ``false`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +-----------------------------------------+---------------------------------------------------------------+---------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** | +------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +------+----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_AnimatedSprite_signal_animation_finished: .. rst-class:: classref-signal **animation_finished** **(** **)** 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. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_signal_frame_changed: .. rst-class:: classref-signal **frame_changed** **(** **)** Emitted when :ref:`frame` changed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimatedSprite_property_animation: .. rst-class:: classref-property :ref:`String` **animation** = ``"default"`` .. rst-class:: classref-property-setget - void **set_animation** **(** :ref:`String` value **)** - :ref:`String` **get_animation** **(** **)** The current animation from the :ref:`frames` resource. If this value changes, the ``frame`` counter is reset. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_centered: .. rst-class:: classref-property :ref:`bool` **centered** = ``true`` .. rst-class:: classref-property-setget - void **set_centered** **(** :ref:`bool` value **)** - :ref:`bool` **is_centered** **(** **)** If ``true``, texture will be centered. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_flip_h: .. rst-class:: classref-property :ref:`bool` **flip_h** = ``false`` .. rst-class:: classref-property-setget - void **set_flip_h** **(** :ref:`bool` value **)** - :ref:`bool` **is_flipped_h** **(** **)** If ``true``, texture is flipped horizontally. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_flip_v: .. rst-class:: classref-property :ref:`bool` **flip_v** = ``false`` .. rst-class:: classref-property-setget - void **set_flip_v** **(** :ref:`bool` value **)** - :ref:`bool` **is_flipped_v** **(** **)** If ``true``, texture is flipped vertically. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_frame: .. rst-class:: classref-property :ref:`int` **frame** = ``0`` .. rst-class:: classref-property-setget - void **set_frame** **(** :ref:`int` value **)** - :ref:`int` **get_frame** **(** **)** The displayed animation frame's index. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_frames: .. rst-class:: classref-property :ref:`SpriteFrames` **frames** .. rst-class:: classref-property-setget - void **set_sprite_frames** **(** :ref:`SpriteFrames` value **)** - :ref:`SpriteFrames` **get_sprite_frames** **(** **)** The :ref:`SpriteFrames` resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the :ref:`SpriteFrames` resource. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_offset** **(** **)** The texture's drawing offset. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_playing: .. rst-class:: classref-property :ref:`bool` **playing** = ``false`` .. rst-class:: classref-property-setget - void **set_playing** **(** :ref:`bool` value **)** - :ref:`bool` **is_playing** **(** **)** If ``true``, the :ref:`animation` is currently playing. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_property_speed_scale: .. rst-class:: classref-property :ref:`float` **speed_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_speed_scale** **(** :ref:`float` value **)** - :ref:`float` **get_speed_scale** **(** **)** The animation speed is multiplied by this value. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimatedSprite_method_play: .. rst-class:: classref-method void **play** **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played. If ``backwards`` is ``true``, the animation will be played in reverse. .. rst-class:: classref-item-separator ---- .. _class_AnimatedSprite_method_stop: .. rst-class:: classref-method void **stop** **(** **)** Stops the current animation (does not reset the frame counter). .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`