: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/SpriteFrames.xml. .. _class_SpriteFrames: SpriteFrames ============ **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Sprite frame library for AnimatedSprite and AnimatedSprite3D. .. rst-class:: classref-introduction-group Description ----------- Sprite frame library for an :ref:`AnimatedSprite` or :ref:`AnimatedSprite3D` node. Contains frames and animation data for playback. \ **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-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------+ | :ref:`Array` | :ref:`frames` | +---------------------------+---------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_animation` **(** :ref:`String` anim **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** :ref:`String` anim **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_all` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_animation` **(** :ref:`String` anim **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SpriteFrames_property_frames: .. rst-class:: classref-property :ref:`Array` **frames** Compatibility property, always equals to an empty array. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SpriteFrames_method_add_animation: .. rst-class:: classref-method void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the library. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_add_frame: .. rst-class:: classref-method void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_clear: .. rst-class:: classref-method void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_clear_all: .. rst-class:: classref-method void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_get_animation_loop: .. rst-class:: classref-method :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** |const| Returns ``true`` if the given animation is configured to loop when it finishes playing. Otherwise, returns ``false``. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_get_animation_names: .. rst-class:: classref-method :ref:`PoolStringArray` **get_animation_names** **(** **)** |const| Returns an array containing the names associated to each animation. Values are placed in alphabetical order. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_get_animation_speed: .. rst-class:: classref-method :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** |const| The animation's speed in frames per second. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_get_frame: .. rst-class:: classref-method :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** |const| Returns the animation's selected frame. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_get_frame_count: .. rst-class:: classref-method :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** |const| Returns the number of frames in the animation. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_has_animation: .. rst-class:: classref-method :ref:`bool` **has_animation** **(** :ref:`String` anim **)** |const| If ``true``, the named animation exists. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_remove_animation: .. rst-class:: classref-method void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_remove_frame: .. rst-class:: classref-method void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_rename_animation: .. rst-class:: classref-method void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_set_animation_loop: .. rst-class:: classref-method void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true``, the animation will loop. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_set_animation_speed: .. rst-class:: classref-method void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. .. rst-class:: classref-item-separator ---- .. _class_SpriteFrames_method_set_frame: .. rst-class:: classref-method void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** Sets the texture of the given frame. .. |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.)`