godot/doc/classes/ReferenceRect.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ReferenceRect" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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>
	<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 [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in the running project.
		</member>
	</members>
</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 17:42:36 -03:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="ReferenceRect" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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 17:42:36 -03: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. 2020-10-19 20:18:53 +03: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 17:42:36 -03:00			`</description>`
			`<tutorials>`
			`</tutorials>`
Fix ReferenceRect border 2018-08-11 10:37:03 +03:00			`<members>`
Better format arguments in variant parser 2019-09-24 14:45:03 -03: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 12:00:32 +03:00			`Sets the border [Color] of the [ReferenceRect].`
			`</member>`
Add `border_width` to `ReferenceRect` Exposes a hidden parameter behind `CanvasItem.draw_rect()`. 2020-10-19 20:41:25 +03: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">`
Improve various texts 2021-11-23 12:20:57 +01:00			`If [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in the running project.`
Fix ReferenceRect border 2018-08-11 10:37:03 +03:00			`</member>`
			`</members>`
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 17:42:36 -03:00			`</class>`