mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
84 lines
3.5 KiB
ReStructuredText
84 lines
3.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ReferenceRect.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ReferenceRect:
|
|
|
|
ReferenceRect
|
|
=============
|
|
|
|
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Reference frame for GUI.
|
|
|
|
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.
|
|
|
|
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`` |
|
|
+---------------------------+----------------------------------------------------------------+-------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ReferenceRect_property_border_color:
|
|
|
|
- :ref:`Color<class_Color>` **border_color**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``Color( 1, 0, 0, 1 )`` |
|
|
+-----------+-------------------------+
|
|
| *Setter* | set_border_color(value) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | get_border_color() |
|
|
+-----------+-------------------------+
|
|
|
|
Sets the border :ref:`Color<class_Color>` of the ``ReferenceRect``.
|
|
|
|
----
|
|
|
|
.. _class_ReferenceRect_property_border_width:
|
|
|
|
- :ref:`float<class_float>` **border_width**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-------------------------+
|
|
| *Setter* | set_border_width(value) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | get_border_width() |
|
|
+-----------+-------------------------+
|
|
|
|
Sets the border width of the ``ReferenceRect``. The border grows both inwards and outwards with respect to the rectangle box.
|
|
|
|
----
|
|
|
|
.. _class_ReferenceRect_property_editor_only:
|
|
|
|
- :ref:`bool<class_bool>` **editor_only**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_editor_only(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | 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.)`
|