mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013. Fixes #1729.
This commit is contained in:
@@ -8,6 +8,7 @@ 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
|
||||
@@ -15,16 +16,32 @@ Brief Description
|
||||
|
||||
2D Sprite node in 3D world.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_Sprite3D_frame>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hframes<class_Sprite3D_hframes>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`region_enabled<class_Sprite3D_region_enabled>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_Sprite3D_region_rect>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Sprite3D_texture>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`vframes<class_Sprite3D_vframes>` |
|
||||
+-------------------------------+------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Sprite3D_frame_changed:
|
||||
.. _class_Sprite3D_frame_changed:
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
|
||||
Emitted when the :ref:`frame<class_Sprite3D_frame>` changes.
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -35,26 +52,73 @@ Property Descriptions
|
||||
|
||||
.. _class_Sprite3D_frame:
|
||||
|
||||
- :ref:`int<class_int>` **frame** - Current frame to display from sprite sheet. :ref:`vframes<class_Sprite3D_vframes>` or :ref:`hframes<class_Sprite3D_hframes>` must be greater than 1.
|
||||
- :ref:`int<class_int>` **frame**
|
||||
|
||||
+----------+------------------+
|
||||
| *Setter* | set_frame(value) |
|
||||
+----------+------------------+
|
||||
| *Getter* | get_frame() |
|
||||
+----------+------------------+
|
||||
|
||||
Current frame to display from sprite sheet. :ref:`vframes<class_Sprite3D_vframes>` or :ref:`hframes<class_Sprite3D_hframes>` must be greater than 1.
|
||||
|
||||
.. _class_Sprite3D_hframes:
|
||||
|
||||
- :ref:`int<class_int>` **hframes** - The number of columns in the sprite sheet.
|
||||
- :ref:`int<class_int>` **hframes**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_hframes(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_hframes() |
|
||||
+----------+--------------------+
|
||||
|
||||
The number of columns in the sprite sheet.
|
||||
|
||||
.. _class_Sprite3D_region_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **region_enabled** - If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect<class_Sprite3D_region_rect>`. Default value: ``false``.
|
||||
- :ref:`bool<class_bool>` **region_enabled**
|
||||
|
||||
+----------+-------------------+
|
||||
| *Setter* | set_region(value) |
|
||||
+----------+-------------------+
|
||||
| *Getter* | is_region() |
|
||||
+----------+-------------------+
|
||||
|
||||
If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect<class_Sprite3D_region_rect>`. Default value: ``false``.
|
||||
|
||||
.. _class_Sprite3D_region_rect:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled<class_Sprite3D_region_enabled>` must be ``true``.
|
||||
- :ref:`Rect2<class_Rect2>` **region_rect**
|
||||
|
||||
+----------+------------------------+
|
||||
| *Setter* | set_region_rect(value) |
|
||||
+----------+------------------------+
|
||||
| *Getter* | get_region_rect() |
|
||||
+----------+------------------------+
|
||||
|
||||
The region of the atlas texture to display. :ref:`region_enabled<class_Sprite3D_region_enabled>` must be ``true``.
|
||||
|
||||
.. _class_Sprite3D_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **texture** - :ref:`Texture<class_Texture>` object to draw.
|
||||
- :ref:`Texture<class_Texture>` **texture**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_texture(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_texture() |
|
||||
+----------+--------------------+
|
||||
|
||||
:ref:`Texture<class_Texture>` object to draw.
|
||||
|
||||
.. _class_Sprite3D_vframes:
|
||||
|
||||
- :ref:`int<class_int>` **vframes** - The number of rows in the sprite sheet.
|
||||
- :ref:`int<class_int>` **vframes**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_vframes(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_vframes() |
|
||||
+----------+--------------------+
|
||||
|
||||
The number of rows in the sprite sheet.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user