mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
123 lines
6.2 KiB
ReStructuredText
123 lines
6.2 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Sprite3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Sprite3D:
|
|
|
|
Sprite3D
|
|
========
|
|
|
|
**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.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_frame<class_Sprite3D_get_frame>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_hframes<class_Sprite3D_get_hframes>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_Sprite3D_get_region_rect>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Sprite3D_get_texture>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_vframes<class_Sprite3D_get_vframes>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_region<class_Sprite3D_is_region>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_frame<class_Sprite3D_set_frame>` **(** :ref:`int<class_int>` frame **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_hframes<class_Sprite3D_set_hframes>` **(** :ref:`int<class_int>` hframes **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_region<class_Sprite3D_set_region>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_region_rect<class_Sprite3D_set_region_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_texture<class_Sprite3D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_vframes<class_Sprite3D_set_vframes>` **(** :ref:`int<class_int>` vframes **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
- **frame_changed** **(** **)**
|
|
|
|
Emitted when the member frame changes.
|
|
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`int<class_int>` **frame** - Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
|
|
- :ref:`int<class_int>` **hframes** - The number of columns in the sprite sheet.
|
|
- :ref:`bool<class_bool>` **region_enabled** - If [code]true[/code] texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code].
|
|
- :ref:`Rect2<class_rect2>` **region_rect** - The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
|
|
- :ref:`Texture<class_texture>` **texture** - [Texture] object to draw.
|
|
- :ref:`int<class_int>` **vframes** - The number of rows in the sprite sheet.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_Sprite3D_get_frame:
|
|
|
|
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
|
|
|
.. _class_Sprite3D_get_hframes:
|
|
|
|
- :ref:`int<class_int>` **get_hframes** **(** **)** const
|
|
|
|
.. _class_Sprite3D_get_region_rect:
|
|
|
|
- :ref:`Rect2<class_rect2>` **get_region_rect** **(** **)** const
|
|
|
|
.. _class_Sprite3D_get_texture:
|
|
|
|
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
|
|
|
|
.. _class_Sprite3D_get_vframes:
|
|
|
|
- :ref:`int<class_int>` **get_vframes** **(** **)** const
|
|
|
|
.. _class_Sprite3D_is_region:
|
|
|
|
- :ref:`bool<class_bool>` **is_region** **(** **)** const
|
|
|
|
.. _class_Sprite3D_set_frame:
|
|
|
|
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
|
|
|
.. _class_Sprite3D_set_hframes:
|
|
|
|
- void **set_hframes** **(** :ref:`int<class_int>` hframes **)**
|
|
|
|
.. _class_Sprite3D_set_region:
|
|
|
|
- void **set_region** **(** :ref:`bool<class_bool>` enabled **)**
|
|
|
|
.. _class_Sprite3D_set_region_rect:
|
|
|
|
- void **set_region_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
|
|
|
.. _class_Sprite3D_set_texture:
|
|
|
|
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
|
|
|
.. _class_Sprite3D_set_vframes:
|
|
|
|
- void **set_vframes** **(** :ref:`int<class_int>` vframes **)**
|
|
|
|
|