summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormrawlingst <mrawlingst@gmail.com>2017-09-08 09:24:16 -0400
committermrawlingst <mrawlingst@gmail.com>2017-09-08 09:24:16 -0400
commit06627fad2017870a062fb1edb9580d197195cbc9 (patch)
tree78454171238f47ec10bfbb48894746c7314ef636
parentd1cb73b47a17de830d9474026ffa7b3587cfbc68 (diff)
Update ColorRect class ref documentation
-rw-r--r--doc/base/classes.xml18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index a097470306..7776bb1ce5 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -12572,6 +12572,12 @@
<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>
@@ -12619,14 +12625,21 @@
</class>
<class name="ColorRect" inherits="Control" category="Core">
<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>
<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">
@@ -12635,6 +12648,11 @@
<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>