virtualx-engine/doc/classes/ReferenceRect.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ReferenceRect" inherits="Control" version="3.4">
	<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Update classref headers with 3.4 version 2021-04-26 13:14:51 +02:00			`<class name="ReferenceRect" inherits="Control" version="3.4">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Reference frame for GUI.`
			`</brief_description>`
			`<description>`
Cross-reference `ColorRect` and `ReferenceRect` in the class reference They use the same underlying `CanvasItem.draw_rect()` API. (cherry picked from commit 803b046b38397ade406b7ae2ec1f7191d08e3753) 2020-10-19 19:18:53 +02:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
Fix ReferenceRect border 2018-08-11 09:37:03 +02:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="border_color" type="Color" setter="set_border_color" getter="get_border_color" default="Color( 1, 0, 0, 1 )">`
Fix ReferenceRect node ReferenceRect node by default was only displaying in the editor and not when the game is running. 2019-06-25 11:00:32 +02:00			`Sets the border [Color] of the [ReferenceRect].`
			`</member>`
Add `border_width` to `ReferenceRect` Exposes a hidden parameter behind `CanvasItem.draw_rect()`. (cherry picked from commit aef00021a9c8a51326d6ed6f9a4fc9ddeae175bd) 2020-10-19 19:41:25 +02:00			`<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>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="editor_only" type="bool" setter="set_editor_only" getter="get_editor_only" default="true">`
Fix ReferenceRect node ReferenceRect node by default was only displaying in the editor and not when the game is running. 2019-06-25 11:00:32 +02:00			`If set to [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in game.`
Fix ReferenceRect border 2018-08-11 09:37:03 +02:00			`</member>`
			`</members>`
doc: Sync classref with current source 2018-08-21 00:35:30 +02:00			`<constants>`
			`</constants>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</class>`