:github_url: hide

.. Generated automatically by doc/tools/makerst.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>`

**Category:** Core

Brief Description
-----------------

Reference frame for GUI.

Properties
----------

+---------------------------+----------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`border_color<class_ReferenceRect_property_border_color>` | Color( 1, 0, 0, 1 ) |
+---------------------------+----------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>`   | :ref:`editor_only<class_ReferenceRect_property_editor_only>`   | true                |
+---------------------------+----------------------------------------------------------------+---------------------+

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>`.

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_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.