classref: Sync with current 3.x branch (995c24415)

This commit is contained in:
Yuri Sizov
2023-04-13 18:01:11 +02:00
parent f15871e2b2
commit 99c2ec8fb3
709 changed files with 116000 additions and 57747 deletions

View File

@@ -14,71 +14,86 @@ ReferenceRect
Reference frame for GUI.
.. rst-class:: classref-introduction-group
Description
-----------
A rectangle box that displays only a :ref:`border_color<class_ReferenceRect_property_border_color>` border color around its rectangle. ``ReferenceRect`` has no fill :ref:`Color<class_Color>`. If you need to display a rectangle filled with a solid color, consider using :ref:`ColorRect<class_ColorRect>` instead.
A rectangle box that displays only a :ref:`border_color<class_ReferenceRect_property_border_color>` border color around its rectangle. **ReferenceRect** has no fill :ref:`Color<class_Color>`. If you need to display a rectangle filled with a solid color, consider using :ref:`ColorRect<class_ColorRect>` instead.
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`border_color<class_ReferenceRect_property_border_color>` | ``Color( 1, 0, 0, 1 )`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>` | :ref:`border_width<class_ReferenceRect_property_border_width>` | ``1.0`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_only<class_ReferenceRect_property_editor_only>` | ``true`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
.. table::
:widths: auto
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`border_color<class_ReferenceRect_property_border_color>` | ``Color( 1, 0, 0, 1 )`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>` | :ref:`border_width<class_ReferenceRect_property_border_width>` | ``1.0`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_only<class_ReferenceRect_property_editor_only>` | ``true`` |
+---------------------------+----------------------------------------------------------------+-------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ReferenceRect_property_border_color:
- :ref:`Color<class_Color>` **border_color**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``Color( 1, 0, 0, 1 )`` |
+-----------+-------------------------+
| *Setter* | set_border_color(value) |
+-----------+-------------------------+
| *Getter* | get_border_color() |
+-----------+-------------------------+
:ref:`Color<class_Color>` **border_color** = ``Color( 1, 0, 0, 1 )``
Sets the border :ref:`Color<class_Color>` of the ``ReferenceRect``.
.. rst-class:: classref-property-setget
- void **set_border_color** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_border_color** **(** **)**
Sets the border :ref:`Color<class_Color>` of the **ReferenceRect**.
.. rst-class:: classref-item-separator
----
.. _class_ReferenceRect_property_border_width:
- :ref:`float<class_float>` **border_width**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``1.0`` |
+-----------+-------------------------+
| *Setter* | set_border_width(value) |
+-----------+-------------------------+
| *Getter* | get_border_width() |
+-----------+-------------------------+
:ref:`float<class_float>` **border_width** = ``1.0``
Sets the border width of the ``ReferenceRect``. The border grows both inwards and outwards with respect to the rectangle box.
.. rst-class:: classref-property-setget
- void **set_border_width** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_border_width** **(** **)**
Sets the border width of the **ReferenceRect**. The border grows both inwards and outwards with respect to the rectangle box.
.. rst-class:: classref-item-separator
----
.. _class_ReferenceRect_property_editor_only:
- :ref:`bool<class_bool>` **editor_only**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``true`` |
+-----------+------------------------+
| *Setter* | set_editor_only(value) |
+-----------+------------------------+
| *Getter* | get_editor_only() |
+-----------+------------------------+
:ref:`bool<class_bool>` **editor_only** = ``true``
If set to ``true``, the ``ReferenceRect`` will only be visible while in editor. Otherwise, ``ReferenceRect`` will be visible in game.
.. rst-class:: classref-property-setget
- void **set_editor_only** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_editor_only** **(** **)**
If set to ``true``, the **ReferenceRect** will only be visible while in editor. Otherwise, **ReferenceRect** will be visible in game.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`