Files
godot-docs/classes/class_colorrect.rst
2021-10-06 11:19:07 +02:00

69 lines
2.4 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ColorRect.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ColorRect:
ColorRect
=========
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Colored rectangle.
Description
-----------
Displays a rectangle filled with a solid :ref:`color<class_ColorRect_property_color>`. If you need to display the border alone, consider using :ref:`ReferenceRect<class_ReferenceRect>` instead.
Tutorials
---------
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
Properties
----------
+---------------------------+----------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------+----------------------------------------------+-----------------------+
Property Descriptions
---------------------
.. _class_ColorRect_property_color:
- :ref:`Color<class_Color>` **color**
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
| *Setter* | set_color(value) |
+-----------+-----------------------+
| *Getter* | get_color() |
+-----------+-----------------------+
The fill color.
.. tabs::
.. code-tab:: gdscript
$ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red.
.. code-tab:: csharp
GetNode<ColorRect>("ColorRect").Color = new Color(1, 0, 0, 1); // Set ColorRect's color to red.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`