godot-docs/classes/class_spriteframes.rst

:github_url: hide

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

.. _class_SpriteFrames:

SpriteFrames
============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Sprite frame library for AnimatedSprite.

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

Sprite frame library for :ref:`AnimatedSprite<class_AnimatedSprite>`. Contains frames and animation data for playback.

Properties
----------

+---------------------------+---------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`frames<class_SpriteFrames_property_frames>` |
+---------------------------+---------------------------------------------------+

Methods
-------

+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`add_animation<class_SpriteFrames_method_add_animation>` **(** :ref:`StringName<class_StringName>` anim **)**                                                                        |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`add_frame<class_SpriteFrames_method_add_frame>` **(** :ref:`StringName<class_StringName>` anim, :ref:`Texture2D<class_Texture2D>` frame, :ref:`int<class_int>` at_position=-1 **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`clear<class_SpriteFrames_method_clear>` **(** :ref:`StringName<class_StringName>` anim **)**                                                                                        |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`clear_all<class_SpriteFrames_method_clear_all>` **(** **)**                                                                                                                         |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                           | :ref:`get_animation_loop<class_SpriteFrames_method_get_animation_loop>` **(** :ref:`StringName<class_StringName>` anim **)** const                                                        |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_animation_names<class_SpriteFrames_method_get_animation_names>` **(** **)** const                                                                                               |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                         | :ref:`get_animation_speed<class_SpriteFrames_method_get_animation_speed>` **(** :ref:`StringName<class_StringName>` anim **)** const                                                      |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>`                 | :ref:`get_frame<class_SpriteFrames_method_get_frame>` **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx **)** const                                               |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_frame_count<class_SpriteFrames_method_get_frame_count>` **(** :ref:`StringName<class_StringName>` anim **)** const                                                              |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                           | :ref:`has_animation<class_SpriteFrames_method_has_animation>` **(** :ref:`StringName<class_StringName>` anim **)** const                                                                  |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`remove_animation<class_SpriteFrames_method_remove_animation>` **(** :ref:`StringName<class_StringName>` anim **)**                                                                  |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`remove_frame<class_SpriteFrames_method_remove_frame>` **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx **)**                                               |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`rename_animation<class_SpriteFrames_method_rename_animation>` **(** :ref:`StringName<class_StringName>` anim, :ref:`StringName<class_StringName>` newname **)**                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`set_animation_loop<class_SpriteFrames_method_set_animation_loop>` **(** :ref:`StringName<class_StringName>` anim, :ref:`bool<class_bool>` loop **)**                                |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`set_animation_speed<class_SpriteFrames_method_set_animation_speed>` **(** :ref:`StringName<class_StringName>` anim, :ref:`float<class_float>` speed **)**                           |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                              | :ref:`set_frame<class_SpriteFrames_method_set_frame>` **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` txt **)**              |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_SpriteFrames_property_frames:

- :ref:`Array<class_Array>` **frames**

Compatibility property, always equals to an empty array.

Method Descriptions
-------------------

.. _class_SpriteFrames_method_add_animation:

- void **add_animation** **(** :ref:`StringName<class_StringName>` anim **)**

Adds a new animation to the library.

----

.. _class_SpriteFrames_method_add_frame:

- void **add_frame** **(** :ref:`StringName<class_StringName>` anim, :ref:`Texture2D<class_Texture2D>` frame, :ref:`int<class_int>` at_position=-1 **)**

Adds a frame to the given animation.

----

.. _class_SpriteFrames_method_clear:

- void **clear** **(** :ref:`StringName<class_StringName>` anim **)**

Removes all frames from the given animation.

----

.. _class_SpriteFrames_method_clear_all:

- void **clear_all** **(** **)**

Removes all animations. A "default" animation will be created.

----

.. _class_SpriteFrames_method_get_animation_loop:

- :ref:`bool<class_bool>` **get_animation_loop** **(** :ref:`StringName<class_StringName>` anim **)** const

If ``true``, the given animation will loop.

----

.. _class_SpriteFrames_method_get_animation_names:

- :ref:`PackedStringArray<class_PackedStringArray>` **get_animation_names** **(** **)** const

Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

----

.. _class_SpriteFrames_method_get_animation_speed:

- :ref:`float<class_float>` **get_animation_speed** **(** :ref:`StringName<class_StringName>` anim **)** const

The animation's speed in frames per second.

----

.. _class_SpriteFrames_method_get_frame:

- :ref:`Texture2D<class_Texture2D>` **get_frame** **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx **)** const

Returns the animation's selected frame.

----

.. _class_SpriteFrames_method_get_frame_count:

- :ref:`int<class_int>` **get_frame_count** **(** :ref:`StringName<class_StringName>` anim **)** const

Returns the number of frames in the animation.

----

.. _class_SpriteFrames_method_has_animation:

- :ref:`bool<class_bool>` **has_animation** **(** :ref:`StringName<class_StringName>` anim **)** const

If ``true``, the named animation exists.

----

.. _class_SpriteFrames_method_remove_animation:

- void **remove_animation** **(** :ref:`StringName<class_StringName>` anim **)**

Removes the given animation.

----

.. _class_SpriteFrames_method_remove_frame:

- void **remove_frame** **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx **)**

Removes the animation's selected frame.

----

.. _class_SpriteFrames_method_rename_animation:

- void **rename_animation** **(** :ref:`StringName<class_StringName>` anim, :ref:`StringName<class_StringName>` newname **)**

Changes the animation's name to ``newname``.

----

.. _class_SpriteFrames_method_set_animation_loop:

- void **set_animation_loop** **(** :ref:`StringName<class_StringName>` anim, :ref:`bool<class_bool>` loop **)**

If ``true``, the animation will loop.

----

.. _class_SpriteFrames_method_set_animation_speed:

- void **set_animation_speed** **(** :ref:`StringName<class_StringName>` anim, :ref:`float<class_float>` speed **)**

The animation's speed in frames per second.

----

.. _class_SpriteFrames_method_set_frame:

- void **set_frame** **(** :ref:`StringName<class_StringName>` anim, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` txt **)**

Sets the texture of the given frame.