mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
243 lines
9.7 KiB
ReStructuredText
243 lines
9.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimatedSprite.xml.
|
|
|
|
.. _class_AnimatedSprite:
|
|
|
|
AnimatedSprite
|
|
==============
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Sprite node that contains multiple textures as frames to play for animation.
|
|
|
|
Description
|
|
-----------
|
|
|
|
``AnimatedSprite`` is similar to the :ref:`Sprite<class_Sprite>` node, except it carries multiple textures as animation frames. Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource, which allows you to import image files (or a folder containing said files) to provide the animation frames for the sprite. The :ref:`SpriteFrames<class_SpriteFrames>` resource can be configured in the editor via the SpriteFrames bottom panel.
|
|
|
|
\ **Note:** You can associate a set of normal or specular maps by creating additional :ref:`SpriteFrames<class_SpriteFrames>` resources with a ``_normal`` or ``_specular`` suffix. For example, having 3 :ref:`SpriteFrames<class_SpriteFrames>` resources ``run``, ``run_normal``, and ``run_specular`` will make it so the ``run`` animation uses normal and specular maps.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`2D Sprite animation <../tutorials/2d/2d_sprite_animation>`
|
|
|
|
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` | ``"default"`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` | ``true`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` | ``false`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` | ``false`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | ``0`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | ``Vector2( 0, 0 )`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` | ``false`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` | ``1.0`` |
|
|
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`play<class_AnimatedSprite_method_play>` **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)** |
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`stop<class_AnimatedSprite_method_stop>` **(** **)** |
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_AnimatedSprite_signal_animation_finished:
|
|
|
|
- **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.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_signal_frame_changed:
|
|
|
|
- **frame_changed** **(** **)**
|
|
|
|
Emitted when :ref:`frame<class_AnimatedSprite_property_frame>` changed.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AnimatedSprite_property_animation:
|
|
|
|
- :ref:`String<class_String>` **animation**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``"default"`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_animation(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_animation() |
|
|
+-----------+----------------------+
|
|
|
|
The current animation from the :ref:`frames<class_AnimatedSprite_property_frames>` resource. If this value changes, the ``frame`` counter is reset.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_centered:
|
|
|
|
- :ref:`bool<class_bool>` **centered**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_centered(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_centered() |
|
|
+-----------+---------------------+
|
|
|
|
If ``true``, texture will be centered.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_flip_h:
|
|
|
|
- :ref:`bool<class_bool>` **flip_h**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_flip_h(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | is_flipped_h() |
|
|
+-----------+-------------------+
|
|
|
|
If ``true``, texture is flipped horizontally.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_flip_v:
|
|
|
|
- :ref:`bool<class_bool>` **flip_v**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_flip_v(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | is_flipped_v() |
|
|
+-----------+-------------------+
|
|
|
|
If ``true``, texture is flipped vertically.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_frame:
|
|
|
|
- :ref:`int<class_int>` **frame**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_frame(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_frame() |
|
|
+-----------+------------------+
|
|
|
|
The displayed animation frame's index.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_frames:
|
|
|
|
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
|
|
|
|
+----------+--------------------------+
|
|
| *Setter* | set_sprite_frames(value) |
|
|
+----------+--------------------------+
|
|
| *Getter* | get_sprite_frames() |
|
|
+----------+--------------------------+
|
|
|
|
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the :ref:`SpriteFrames<class_SpriteFrames>` resource.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_offset:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **offset**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_offset(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_offset() |
|
|
+-----------+---------------------+
|
|
|
|
The texture's drawing offset.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_playing:
|
|
|
|
- :ref:`bool<class_bool>` **playing**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_playing(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | is_playing() |
|
|
+-----------+--------------------+
|
|
|
|
If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_property_speed_scale:
|
|
|
|
- :ref:`float<class_float>` **speed_scale**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_speed_scale(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_speed_scale() |
|
|
+-----------+------------------------+
|
|
|
|
The animation speed is multiplied by this value.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_AnimatedSprite_method_play:
|
|
|
|
- void **play** **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)**
|
|
|
|
Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played. If ``backwards`` is ``true``, the animation will be played in reverse.
|
|
|
|
----
|
|
|
|
.. _class_AnimatedSprite_method_stop:
|
|
|
|
- void **stop** **(** **)**
|
|
|
|
Stops the current animation (does not reset the frame counter).
|
|
|
|
.. |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.)`
|