godot-docs/classes/class_animatedsprite.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AnimatedSprite.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AnimatedSprite:

AnimatedSprite
==============

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Sprite node that can use multiple textures for animation.

Member Functions
----------------

+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`              | :ref:`get_animation<class_AnimatedSprite_get_animation>`  **(** **)** const                                                          |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                    | :ref:`get_frame<class_AnimatedSprite_get_frame>`  **(** **)** const                                                                  |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`            | :ref:`get_offset<class_AnimatedSprite_get_offset>`  **(** **)** const                                                                |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpriteFrames<class_spriteframes>`  | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>`  **(** **)** const                                                  |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_centered<class_AnimatedSprite_is_centered>`  **(** **)** const                                                              |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_flipped_h<class_AnimatedSprite_is_flipped_h>`  **(** **)** const                                                            |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_flipped_v<class_AnimatedSprite_is_flipped_v>`  **(** **)** const                                                            |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_playing<class_AnimatedSprite_is_playing>`  **(** **)** const                                                                |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`play<class_AnimatedSprite_play>`  **(** :ref:`String<class_string>` anim=""  **)**                                             |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_animation<class_AnimatedSprite_set_animation>`  **(** :ref:`String<class_string>` animation  **)**                         |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_centered<class_AnimatedSprite_set_centered>`  **(** :ref:`bool<class_bool>` centered  **)**                                |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_flip_h<class_AnimatedSprite_set_flip_h>`  **(** :ref:`bool<class_bool>` flip_h  **)**                                      |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_flip_v<class_AnimatedSprite_set_flip_v>`  **(** :ref:`bool<class_bool>` flip_v  **)**                                      |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_frame<class_AnimatedSprite_set_frame>`  **(** :ref:`int<class_int>` frame  **)**                                           |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_offset<class_AnimatedSprite_set_offset>`  **(** :ref:`Vector2<class_vector2>` offset  **)**                                |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>`  **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames  **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`stop<class_AnimatedSprite_stop>`  **(** **)**                                                                                  |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **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.

-  **frame_changed**  **(** **)**

Emitted when member frame changed.


Member Variables
----------------

- :ref:`String<class_string>` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
- :ref:`bool<class_bool>` **centered** - If ``true`` texture will be centered. Default value: ``true``.
- :ref:`bool<class_bool>` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``.
- :ref:`bool<class_bool>` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``.
- :ref:`int<class_int>` **frame** - The displayed animation frame's index.
- :ref:`SpriteFrames<class_spriteframes>` **frames** - The :ref:`SpriteFrames<class_spriteframes>` resource containing the animation(s).
- :ref:`Vector2<class_vector2>` **offset** - The texture's drawing offset.
- :ref:`bool<class_bool>` **playing** - If ``true`` the member animation is currently playing.

Description
-----------

Animations are created using a :ref:`SpriteFrames<class_spriteframes>` resource, which can be configured in the editor via the SpriteFrames panel.

Member Function Description
---------------------------

.. _class_AnimatedSprite_get_animation:

- :ref:`String<class_string>`  **get_animation**  **(** **)** const

Return the name of the current animation set to the node.

.. _class_AnimatedSprite_get_frame:

- :ref:`int<class_int>`  **get_frame**  **(** **)** const

Return the visible frame index.

.. _class_AnimatedSprite_get_offset:

- :ref:`Vector2<class_vector2>`  **get_offset**  **(** **)** const

Return the offset of the sprite in the node origin.

.. _class_AnimatedSprite_get_sprite_frames:

- :ref:`SpriteFrames<class_spriteframes>`  **get_sprite_frames**  **(** **)** const

Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.

.. _class_AnimatedSprite_is_centered:

- :ref:`bool<class_bool>`  **is_centered**  **(** **)** const

Return true when centered. See :ref:`set_centered<class_AnimatedSprite_set_centered>`.

.. _class_AnimatedSprite_is_flipped_h:

- :ref:`bool<class_bool>`  **is_flipped_h**  **(** **)** const

Return true if sprite is flipped horizontally.

.. _class_AnimatedSprite_is_flipped_v:

- :ref:`bool<class_bool>`  **is_flipped_v**  **(** **)** const

Return true if sprite is flipped vertically.

.. _class_AnimatedSprite_is_playing:

- :ref:`bool<class_bool>`  **is_playing**  **(** **)** const

Return true if an animation if currently being played.

.. _class_AnimatedSprite_play:

- void  **play**  **(** :ref:`String<class_string>` anim=""  **)**

Play the animation set in parameter. If no parameter is provided, the current animation is played.

.. _class_AnimatedSprite_set_animation:

- void  **set_animation**  **(** :ref:`String<class_string>` animation  **)**

Set the current animation of the node and reinits the frame counter of the animation.

.. _class_AnimatedSprite_set_centered:

- void  **set_centered**  **(** :ref:`bool<class_bool>` centered  **)**

When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.

.. _class_AnimatedSprite_set_flip_h:

- void  **set_flip_h**  **(** :ref:`bool<class_bool>` flip_h  **)**

If true, sprite is flipped horizontally.

.. _class_AnimatedSprite_set_flip_v:

- void  **set_flip_v**  **(** :ref:`bool<class_bool>` flip_v  **)**

If true, sprite is flipped vertically.

.. _class_AnimatedSprite_set_frame:

- void  **set_frame**  **(** :ref:`int<class_int>` frame  **)**

Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).

.. _class_AnimatedSprite_set_offset:

- void  **set_offset**  **(** :ref:`Vector2<class_vector2>` offset  **)**

Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.

.. _class_AnimatedSprite_set_sprite_frames:

- void  **set_sprite_frames**  **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames  **)**

Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.

.. _class_AnimatedSprite_stop:

- void  **stop**  **(** **)**

Stop the current animation (does not reset the frame counter).