godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ReferenceRect.xml

27 lines
1.3 KiB
XML
Raw Normal View History

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 20:42:36 +00: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-03-16 22:01:02 +00:00
<class name="ReferenceRect" inherits="Control" version="3.5" 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 20:42:36 +00: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 17:18:53 +00: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 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
Fix ReferenceRect border
2018-08-11 07:37:03 +00:00
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 09:00:32 +00: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 17:41:25 +00: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 10:38:01 +00: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 09:00:32 +00: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 07:37:03 +00:00
</member>
</members>
doc: Sync classref with current source
2018-08-20 22:35:30 +00: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 20:42:36 +00:00
</class>