| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AnimatedSprite3D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AnimatedSprite3D:
- AnimatedSprite3D
- ================
- **Inherits:** :ref:`SpriteBase3D<class_spritebase3d>` **<** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- 2D sprite node in 3D world, that can use multiple 2D textures for animation.
- Member Functions
- ----------------
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite3D_get_animation>` **(** **)** const |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite3D_get_sprite_frames>` **(** **)** const |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_is_playing>` **(** **)** const |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`play<class_AnimatedSprite3D_play>` **(** :ref:`String<class_string>` anim="" **)** |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_animation<class_AnimatedSprite3D_set_animation>` **(** :ref:`String<class_string>` animation **)** |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_frame<class_AnimatedSprite3D_set_frame>` **(** :ref:`int<class_int>` frame **)** |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_sprite_frames<class_AnimatedSprite3D_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`stop<class_AnimatedSprite3D_stop>` **(** **)** |
- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_AnimatedSprite3D_frame_changed:
- - **frame_changed** **(** **)**
- Emitted when :ref:`frame<class_AnimatedSprite3D_frame>` changed.
- Member Variables
- ----------------
- .. _class_AnimatedSprite3D_animation:
- - :ref:`String<class_string>` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
- .. _class_AnimatedSprite3D_frame:
- - :ref:`int<class_int>` **frame** - The displayed animation frame's index.
- .. _class_AnimatedSprite3D_frames:
- - :ref:`SpriteFrames<class_spriteframes>` **frames** - The :ref:`SpriteFrames<class_spriteframes>` resource containing the animation(s).
- .. _class_AnimatedSprite3D_playing:
- - :ref:`bool<class_bool>` **playing** - If ``true`` the :ref:`animation<class_AnimatedSprite3D_animation>` is currently playing.
- Description
- -----------
- Animations are created using a :ref:`SpriteFrames<class_spriteframes>` resource, which can be configured in the editor via the SpriteFrames panel.
- Member Function Description
- ---------------------------
- .. _class_AnimatedSprite3D_get_animation:
- - :ref:`String<class_string>` **get_animation** **(** **)** const
- Return the name of the current animation set to the node.
- .. _class_AnimatedSprite3D_get_frame:
- - :ref:`int<class_int>` **get_frame** **(** **)** const
- Return the visible frame index.
- .. _class_AnimatedSprite3D_get_sprite_frames:
- - :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
- Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
- .. _class_AnimatedSprite3D_is_playing:
- - :ref:`bool<class_bool>` **is_playing** **(** **)** const
- Return true if an animation if currently being played.
- .. _class_AnimatedSprite3D_play:
- - void **play** **(** :ref:`String<class_string>` anim="" **)**
- Play the animation set in parameter. If no parameter is provided, the current animation is played.
- .. _class_AnimatedSprite3D_set_animation:
- - void **set_animation** **(** :ref:`String<class_string>` animation **)**
- Set the current animation of the node and reinits the frame counter of the animation.
- .. _class_AnimatedSprite3D_set_frame:
- - void **set_frame** **(** :ref:`int<class_int>` frame **)**
- Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
- .. _class_AnimatedSprite3D_set_sprite_frames:
- - void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
- Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
- .. _class_AnimatedSprite3D_stop:
- - void **stop** **(** **)**
- Stop the current animation (does not reset the frame counter).
|
