summaryrefslogtreecommitdiff
path: root/doc/classes/ReferenceRect.xml
blob: df9a6f0a468582ed255b28b4c2a8ea0ddd8642db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ReferenceRect" inherits="Control" version="4.0">
	<brief_description>
		Reference frame for GUI.
	</brief_description>
	<description>
		A rectangle box that displays only a [member 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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="border_color" type="Color" setter="set_border_color" getter="get_border_color" default="Color(1, 0, 0, 1)">
			Sets the border [Color] of the [ReferenceRect].
		</member>
		<member name="border_width" type="float" setter="set_border_width" getter="get_border_width" default="1.0">
			Sets the border width of the [ReferenceRect]. The border grows both inwards and outwards with respect to the rectangle box.
		</member>
		<member name="editor_only" type="bool" setter="set_editor_only" getter="get_editor_only" default="true">
			If set to [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in game.
		</member>
	</members>
	<constants>
	</constants>
</class>