:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedTexture.xml. .. _class_AnimatedTexture: AnimatedTexture =============== **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Proxy texture for simple frame-based animations. .. rst-class:: classref-introduction-group Description ----------- **AnimatedTexture** is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer` or :ref:`AnimatedSprite2D`, it isn't a :ref:`Node`, but has the advantage of being usable anywhere a :ref:`Texture2D` resource can be used, e.g. in a :ref:`TileSet`. The playback of the animation is controlled by the :ref:`speed_scale` property, as well as each frame's duration (see :ref:`set_frame_duration`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. \ **AnimatedTexture** currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. \ **Note:** AnimatedTexture doesn't support using :ref:`AtlasTexture`\ s. Each frame needs to be a separate :ref:`Texture2D`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`current_frame` | | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`frames` | ``1`` | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`one_shot` | ``false`` | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`pause` | ``false`` | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_frame_duration` **(** :ref:`int` frame **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame_duration` **(** :ref:`int` frame, :ref:`float` duration **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture2D` texture **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_AnimatedTexture_constant_MAX_FRAMES: .. rst-class:: classref-constant **MAX_FRAMES** = ``256`` The maximum number of frames supported by **AnimatedTexture**. If you need more frames in your animation, use :ref:`AnimationPlayer` or :ref:`AnimatedSprite2D`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimatedTexture_property_current_frame: .. rst-class:: classref-property :ref:`int` **current_frame** .. rst-class:: classref-property-setget - void **set_current_frame** **(** :ref:`int` value **)** - :ref:`int` **get_current_frame** **(** **)** Sets the currently visible frame of the texture. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_property_frames: .. rst-class:: classref-property :ref:`int` **frames** = ``1`` .. rst-class:: classref-property-setget - void **set_frames** **(** :ref:`int` value **)** - :ref:`int` **get_frames** **(** **)** Number of frames to use in the animation. While you can create the frames independently with :ref:`set_frame_texture`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`MAX_FRAMES`. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_property_one_shot: .. rst-class:: classref-property :ref:`bool` **one_shot** = ``false`` .. rst-class:: classref-property-setget - void **set_one_shot** **(** :ref:`bool` value **)** - :ref:`bool` **get_one_shot** **(** **)** If ``true``, the animation will only play once and will not loop back to the first frame after reaching the end. Note that reaching the end will not set :ref:`pause` to ``true``. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_property_pause: .. rst-class:: classref-property :ref:`bool` **pause** = ``false`` .. rst-class:: classref-property-setget - void **set_pause** **(** :ref:`bool` value **)** - :ref:`bool` **get_pause** **(** **)** If ``true``, the animation will pause where it currently is (i.e. at :ref:`current_frame`). The animation will continue from where it was paused when changing this property to ``false``. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_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. If set to a negative value, the animation is played in reverse. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimatedTexture_method_get_frame_duration: .. rst-class:: classref-method :ref:`float` **get_frame_duration** **(** :ref:`int` frame **)** |const| Returns the given ``frame``'s duration, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_method_get_frame_texture: .. rst-class:: classref-method :ref:`Texture2D` **get_frame_texture** **(** :ref:`int` frame **)** |const| Returns the given frame's :ref:`Texture2D`. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_method_set_frame_duration: .. rst-class:: classref-method void **set_frame_duration** **(** :ref:`int` frame, :ref:`float` duration **)** Sets the duration of any given ``frame``. The final duration is affected by the :ref:`speed_scale`. If set to ``0``, the frame is skipped during playback. .. rst-class:: classref-item-separator ---- .. _class_AnimatedTexture_method_set_frame_texture: .. rst-class:: classref-method void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture2D` texture **)** Assigns a :ref:`Texture2D` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames` - 1. You can define any number of textures up to :ref:`MAX_FRAMES`, but keep in mind that only frames from 0 to :ref:`frames` - 1 will be part of the animation. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`