godot/doc/classes/ColorRect.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

50 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ColorRect" inherits="Control" category="Core" version="3.0-alpha">
<brief_description>
Colored rect for canvas.
</brief_description>
<description>
An object that is represented on the canvas as a rect with color. [Color] is used to set or get color info for the rect.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_frame_color" qualifiers="const">
<return type="Color">
</return>
<description>
Return the color in RGBA format.
[codeblock]
var cr = get_node("colorrect_node")
var c = cr.get_frame_color() # Default color is white
[/codeblock]
</description>
</method>
<method name="set_frame_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
Set new color to ColorRect.
[codeblock]
var cr = get_node("colorrect_node")
cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red
[/codeblock]
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_frame_color" getter="get_frame_color">
The color to fill the [code]ColorRect[/code].
[codeblock]
$ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red
[/codeblock]
</member>
</members>
<constants>
</constants>
</class>