godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
classes/class_ninepatchrect.rst
View File

@@ -59,11 +59,11 @@ Methods
.. table::
:widths: auto
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_patch_margin<class_NinePatchRect_method_get_patch_margin>` **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const| |
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_patch_margin<class_NinePatchRect_method_set_patch_margin>` **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)** |
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_patch_margin<class_NinePatchRect_method_get_patch_margin>`\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const| |
+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_patch_margin<class_NinePatchRect_method_set_patch_margin>`\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ ) |
+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -78,7 +78,7 @@ Signals
.. rst-class:: classref-signal
**texture_changed** **(** **)**
**texture_changed**\ (\ )
Emitted when the node's texture changes.
@@ -138,8 +138,8 @@ Property Descriptions
.. rst-class:: classref-property-setget
- void **set_h_axis_stretch_mode** **(** :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` value **)**
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **get_h_axis_stretch_mode** **(** **)**
- |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>`\ )
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **get_h_axis_stretch_mode**\ (\ )
The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` for possible values.
@@ -155,8 +155,8 @@ The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchM
.. rst-class:: classref-property-setget
- void **set_v_axis_stretch_mode** **(** :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` value **)**
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **get_v_axis_stretch_mode** **(** **)**
- |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>`\ )
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **get_v_axis_stretch_mode**\ (\ )
The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` for possible values.
@@ -172,8 +172,8 @@ The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMod
.. rst-class:: classref-property-setget
- void **set_draw_center** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_draw_center_enabled** **(** **)**
- |void| **set_draw_center**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_draw_center_enabled**\ (\ )
If ``true``, draw the panel's center. Else, only draw the 9-slice's borders.
@@ -189,8 +189,8 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders.
.. rst-class:: classref-property-setget
- void **set_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const|
- |void| **set_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const|
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.
@@ -206,8 +206,8 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto
.. rst-class:: classref-property-setget
- void **set_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const|
- |void| **set_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const|
The width of the 9-slice's left column. A margin of 16 means the 9-slice's left corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
@@ -223,8 +223,8 @@ The width of the 9-slice's left column. A margin of 16 means the 9-slice's left
.. rst-class:: classref-property-setget
- void **set_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const|
- |void| **set_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const|
The width of the 9-slice's right column. A margin of 16 means the 9-slice's right corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
@@ -240,8 +240,8 @@ The width of the 9-slice's right column. A margin of 16 means the 9-slice's righ
.. rst-class:: classref-property-setget
- void **set_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const|
- |void| **set_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const|
The height of the 9-slice's top row. A margin of 16 means the 9-slice's top 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.
@@ -257,8 +257,8 @@ The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corn
.. rst-class:: classref-property-setget
- void **set_region_rect** **(** :ref:`Rect2<class_Rect2>` value **)**
- :ref:`Rect2<class_Rect2>` **get_region_rect** **(** **)**
- |void| **set_region_rect**\ (\ value\: :ref:`Rect2<class_Rect2>`\ )
- :ref:`Rect2<class_Rect2>` **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. If the rect is empty, NinePatchRect will use the whole texture.
@@ -274,8 +274,8 @@ Rectangular region of the texture to sample from. If you're working with an atla
.. rst-class:: classref-property-setget
- void **set_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** **)**
- |void| **set_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- :ref:`Texture2D<class_Texture2D>` **get_texture**\ (\ )
The node's texture resource.
@@ -292,7 +292,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`int<class_int>` **get_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin **)** |const|
:ref:`int<class_int>` **get_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`\ ) |const|
Returns the size of the margin on the specified :ref:`Side<enum_@GlobalScope_Side>`.
@@ -304,7 +304,7 @@ Returns the size of the margin on the specified :ref:`Side<enum_@GlobalScope_Sid
.. rst-class:: classref-method
void **set_patch_margin** **(** :ref:`Side<enum_@GlobalScope_Side>` margin, :ref:`int<class_int>` value **)**
|void| **set_patch_margin**\ (\ margin\: :ref:`Side<enum_@GlobalScope_Side>`, value\: :ref:`int<class_int>`\ )
Sets the size of the margin on the specified :ref:`Side<enum_@GlobalScope_Side>` to ``value`` pixels.
@@ -315,3 +315,4 @@ Sets the size of the margin on the specified :ref:`Side<enum_@GlobalScope_Side>`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`