ReferenceRect

Inherits: Control < CanvasItem < Node < Object

Reference frame for GUI.

Description

A rectangle box that displays only a border_color border color around its rectangle. ReferenceRect has no fill Color. If you need to display a rectangle filled with a solid color, consider using ColorRect instead.

Properties

Color

border_color

Color( 1, 0, 0, 1 )

float

border_width

1.0

bool

editor_only

true

Property Descriptions

Color border_color = Color( 1, 0, 0, 1 )

  • void set_border_color ( Color value )

  • Color get_border_color ( )

Sets the border Color of the ReferenceRect.

float border_width = 1.0

  • void set_border_width ( float value )

  • float get_border_width ( )

Sets the border width of the ReferenceRect. The border grows both inwards and outwards with respect to the rectangle box.

bool editor_only = true

  • void set_editor_only ( bool value )

  • bool get_editor_only ( )

If set to true, the ReferenceRect will only be visible while in editor. Otherwise, ReferenceRect will be visible in game.