summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2017-09-12 11:20:10 +0200
committerGitHub <noreply@github.com>2017-09-12 11:20:10 +0200
commitd455b13fcf7ff7ce5d62c08d97e035cf27805be5 (patch)
tree00f0305647c84181d0700092a3fcdc54350d442b
parentc5b4f3085ffbb1d37eea01a17adab4559f2a69d6 (diff)
parent06627fad2017870a062fb1edb9580d197195cbc9 (diff)
Merge pull request #11051 from mrawlingst/classref-colorrect
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 83cba1e958..90ca2e5b79 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -12673,6 +12673,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>
@@ -12720,14 +12726,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">
@@ -12736,6 +12749,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>