godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 14:03:23 +02:00
parent 5402f28f59
commit a203daa272
397 changed files with 21934 additions and 16529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
classes/class_ninepatchrect.rst
View File

@@ -19,25 +19,25 @@ Scalable texture-based frame that tiles the texture's centers and sides, but kee
Properties
----------
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_horizontal<class_NinePatchRect_property_axis_stretch_horizontal>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_vertical<class_NinePatchRect_property_axis_stretch_vertical>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`draw_center<class_NinePatchRect_property_draw_center>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_bottom<class_NinePatchRect_property_patch_margin_bottom>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_left<class_NinePatchRect_property_patch_margin_left>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_right<class_NinePatchRect_property_patch_margin_right>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_top<class_NinePatchRect_property_patch_margin_top>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_NinePatchRect_property_region_rect>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_NinePatchRect_property_texture>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_horizontal<class_NinePatchRect_property_axis_stretch_horizontal>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_vertical<class_NinePatchRect_property_axis_stretch_vertical>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`draw_center<class_NinePatchRect_property_draw_center>` | true |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_bottom<class_NinePatchRect_property_patch_margin_bottom>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_left<class_NinePatchRect_property_patch_margin_left>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_right<class_NinePatchRect_property_patch_margin_right>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`patch_margin_top<class_NinePatchRect_property_patch_margin_top>` | 0 |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_NinePatchRect_property_region_rect>` | Rect2( 0, 0, 0, 0 ) |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_NinePatchRect_property_texture>` | null |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
Signals
-------
@@ -61,7 +61,7 @@ Enumerations
enum **AxisStretchMode**:
- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``.
- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing.
- **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing.
@@ -79,11 +79,13 @@ Property Descriptions
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **axis_stretch_horizontal**
+----------+--------------------------------+
| *Setter* | set_h_axis_stretch_mode(value) |
+----------+--------------------------------+
| *Getter* | get_h_axis_stretch_mode() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | 0 |
+-----------+--------------------------------+
| *Setter* | set_h_axis_stretch_mode(value) |
+-----------+--------------------------------+
| *Getter* | get_h_axis_stretch_mode() |
+-----------+--------------------------------+
Doesn't do anything at the time of writing.
@@ -91,11 +93,13 @@ Doesn't do anything at the time of writing.
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **axis_stretch_vertical**
+----------+--------------------------------+
| *Setter* | set_v_axis_stretch_mode(value) |
+----------+--------------------------------+
| *Getter* | get_v_axis_stretch_mode() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | 0 |
+-----------+--------------------------------+
| *Setter* | set_v_axis_stretch_mode(value) |
+-----------+--------------------------------+
| *Getter* | get_v_axis_stretch_mode() |
+-----------+--------------------------------+
Doesn't do anything at the time of writing.
@@ -103,23 +107,27 @@ Doesn't do anything at the time of writing.
- :ref:`bool<class_bool>` **draw_center**
+----------+--------------------------+
| *Setter* | set_draw_center(value) |
+----------+--------------------------+
| *Getter* | is_draw_center_enabled() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | true |
+-----------+--------------------------+
| *Setter* | set_draw_center(value) |
+-----------+--------------------------+
| *Getter* | is_draw_center_enabled() |
+-----------+--------------------------+
If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true``.
If ``true``, draw the panel's center. Else, only draw the 9-slice's borders.
.. _class_NinePatchRect_property_patch_margin_bottom:
- :ref:`int<class_int>` **patch_margin_bottom**
+----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+----------+-------------------------+
| *Getter* | get_patch_margin() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+-----------+-------------------------+
| *Getter* | get_patch_margin() |
+-----------+-------------------------+
The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
@@ -127,11 +135,13 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto
- :ref:`int<class_int>` **patch_margin_left**
+----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+----------+-------------------------+
| *Getter* | get_patch_margin() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+-----------+-------------------------+
| *Getter* | get_patch_margin() |
+-----------+-------------------------+
The height of the 9-slice's left column.
@@ -139,11 +149,13 @@ The height of the 9-slice's left column.
- :ref:`int<class_int>` **patch_margin_right**
+----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+----------+-------------------------+
| *Getter* | get_patch_margin() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+-----------+-------------------------+
| *Getter* | get_patch_margin() |
+-----------+-------------------------+
The height of the 9-slice's right column.
@@ -151,11 +163,13 @@ The height of the 9-slice's right column.
- :ref:`int<class_int>` **patch_margin_top**
+----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+----------+-------------------------+
| *Getter* | get_patch_margin() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_patch_margin(value) |
+-----------+-------------------------+
| *Getter* | get_patch_margin() |
+-----------+-------------------------+
The height of the 9-slice's top row.
@@ -163,11 +177,13 @@ The height of the 9-slice's top row.
- :ref:`Rect2<class_Rect2>` **region_rect**
+----------+------------------------+
| *Setter* | set_region_rect(value) |
+----------+------------------------+
| *Getter* | get_region_rect() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | Rect2( 0, 0, 0, 0 ) |
+-----------+------------------------+
| *Setter* | set_region_rect(value) |
+-----------+------------------------+
| *Getter* | get_region_rect() |
+-----------+------------------------+
Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one.
@@ -175,11 +191,13 @@ Rectangular region of the texture to sample from. If you're working with an atla
- :ref:`Texture<class_Texture>` **texture**
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
The node's texture resource.