Files
godot-docs-l10n/classes/es/class_animatedtexture.rst

240 lines
13 KiB
ReStructuredText

:github_url: hide
.. _class_AnimatedTexture:
AnimatedTexture
===============
**Obsoleto:** This class does not work properly in current versions and may be removed in the future. There is currently no equivalent workaround.
**Hereda:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Textura de conexión para animaciones simples basadas en fotogramas.
.. rst-class:: classref-introduction-group
Descripción
----------------------
**AnimatedTexture** es un formato de recurso para animaciones basadas en fotogramas, donde se pueden encadenar múltiples texturas automáticamente con un retardo predefinido para cada fotograma. A diferencia de :ref:`AnimationPlayer<class_AnimationPlayer>` o :ref:`AnimatedSprite2D<class_AnimatedSprite2D>`, no es un :ref:`Node<class_Node>`, pero tiene la ventaja de poderse usar en cualquier lugar donde se pueda usar un recurso :ref:`Texture2D<class_Texture2D>`, p. ej. en un :ref:`TileSet<class_TileSet>`.
La reproducción de la animación está controlada por la propiedad :ref:`speed_scale<class_AnimatedTexture_property_speed_scale>`, así como por la duración de cada fotograma (véase :ref:`set_frame_duration()<class_AnimatedTexture_method_set_frame_duration>`). La animación se repite, es decir, se reiniciará automáticamente en el fotograma 0 tras reproducir el último fotograma.
\ **AnimatedTexture** requiere actualmente que todas las texturas de los fotogramas tengan el mismo tamaño; de lo contrario, las más grandes se recortarán para que coincidan con la más pequeña.
\ **Nota:** AnimatedTexture no admite el uso de :ref:`AtlasTexture<class_AtlasTexture>`\ s. Cada fotograma debe ser una :ref:`Texture2D<class_Texture2D>` independiente.
\ **Advertencia:** La implementación actual no es eficiente para los renderizadores modernos.
.. rst-class:: classref-reftable-group
Propiedades
----------------------
.. table::
:widths: auto
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`current_frame<class_AnimatedTexture_property_current_frame>` | |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_AnimatedTexture_property_one_shot>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pause<class_AnimatedTexture_property_pause>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedTexture_property_speed_scale>` | ``1.0`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Métodos
--------------
.. table::
:widths: auto
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_frame_duration<class_AnimatedTexture_method_get_frame_duration>`\ (\ frame\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_frame_texture<class_AnimatedTexture_method_get_frame_texture>`\ (\ frame\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_frame_duration<class_AnimatedTexture_method_set_frame_duration>`\ (\ frame\: :ref:`int<class_int>`, duration\: :ref:`float<class_float>`\ ) |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>`\ (\ frame\: :ref:`int<class_int>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Constantes
--------------------
.. _class_AnimatedTexture_constant_MAX_FRAMES:
.. rst-class:: classref-constant
**MAX_FRAMES** = ``256`` :ref:`🔗<class_AnimatedTexture_constant_MAX_FRAMES>`
El número máximo de fotogramas soportados por **AnimatedTexture**. Si necesitas más fotogramas en tu animación, usa :ref:`AnimationPlayer<class_AnimationPlayer>` o :ref:`AnimatedSprite2D<class_AnimatedSprite2D>`.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Propiedades
--------------------------------------------------------
.. _class_AnimatedTexture_property_current_frame:
.. rst-class:: classref-property
:ref:`int<class_int>` **current_frame** :ref:`🔗<class_AnimatedTexture_property_current_frame>`
.. rst-class:: classref-property-setget
- |void| **set_current_frame**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_current_frame**\ (\ )
Establece el fotograma actualmente visible de la textura. Establecer este fotograma mientras se reproduce reinicia el tiempo del fotograma actual, por lo que el fotograma recién seleccionado se reproduce durante toda la duración del fotograma configurada.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_property_frames:
.. rst-class:: classref-property
:ref:`int<class_int>` **frames** = ``1`` :ref:`🔗<class_AnimatedTexture_property_frames>`
.. rst-class:: classref-property-setget
- |void| **set_frames**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_frames**\ (\ )
Número de fotogramas a usar en la animación. Aunque puedes crear los fotogramas independientemente con :ref:`set_frame_texture()<class_AnimatedTexture_method_set_frame_texture>`, necesitas establecer este valor para que la animación tenga en cuenta los nuevos fotogramas. El número máximo de fotogramas es :ref:`MAX_FRAMES<class_AnimatedTexture_constant_MAX_FRAMES>`.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_property_one_shot:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **one_shot** = ``false`` :ref:`🔗<class_AnimatedTexture_property_one_shot>`
.. rst-class:: classref-property-setget
- |void| **set_one_shot**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_one_shot**\ (\ )
Si es ``true``, la animación sólo se reproducirá una vez y no volverá al primer fotograma después de llegar al final. Ten en cuenta que al llegar al final no se establecerá :ref:`pause<class_AnimatedTexture_property_pause>` en ``true``.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_property_pause:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **pause** = ``false`` :ref:`🔗<class_AnimatedTexture_property_pause>`
.. rst-class:: classref-property-setget
- |void| **set_pause**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_pause**\ (\ )
Si es ``true``, la animación se detendrá donde se encuentra actualmente (es decir, en :ref:`current_frame<class_AnimatedTexture_property_current_frame>`). La animación continuará desde donde se detuvo al cambiar esta propiedad a ``false``.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_property_speed_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **speed_scale** = ``1.0`` :ref:`🔗<class_AnimatedTexture_property_speed_scale>`
.. rst-class:: classref-property-setget
- |void| **set_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_speed_scale**\ (\ )
La velocidad de la animación se multiplica por este valor. Si se establece un valor negativo, la animación se reproduce en reversa.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Métodos
------------------------------------------------
.. _class_AnimatedTexture_method_get_frame_duration:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_frame_duration**\ (\ frame\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AnimatedTexture_method_get_frame_duration>`
Devuelve la duración del ``frame`` dado, en segundos.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_method_get_frame_texture:
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **get_frame_texture**\ (\ frame\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AnimatedTexture_method_get_frame_texture>`
Devuelve el :ref:`Texture2D<class_Texture2D>` del marco dado.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_method_set_frame_duration:
.. rst-class:: classref-method
|void| **set_frame_duration**\ (\ frame\: :ref:`int<class_int>`, duration\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AnimatedTexture_method_set_frame_duration>`
Establece la duración de cualquier ``frame`` dado. La duración final se ve afectada por el :ref:`speed_scale<class_AnimatedTexture_property_speed_scale>`. Si se establece en ``0``, el fotograma se omite durante la reproducción.
.. rst-class:: classref-item-separator
----
.. _class_AnimatedTexture_method_set_frame_texture:
.. rst-class:: classref-method
|void| **set_frame_texture**\ (\ frame\: :ref:`int<class_int>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_AnimatedTexture_method_set_frame_texture>`
Asigna una :ref:`Texture2D<class_Texture2D>` al fotograma dado. Los ID de los fotogramas empiezan en 0, así que el primer fotograma tiene ID 0, y el último fotograma de la animación tiene ID :ref:`frames<class_AnimatedTexture_property_frames>` - 1.
Puedes definir cualquier número de texturas hasta :ref:`MAX_FRAMES<class_AnimatedTexture_constant_MAX_FRAMES>`, pero ten en cuenta que solo los fotogramas de 0 a :ref:`frames<class_AnimatedTexture_property_frames>` - 1 formarán parte de la animación.
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`