Files
godot-docs/classes/class_colorrect.rst
2024-09-10 13:19:38 +00:00

73 lines
2.3 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorRect.xml.
.. _class_ColorRect:
ColorRect
=========
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Colored rectangle.
.. rst-class:: classref-introduction-group
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.
.. rst-class:: classref-introduction-group
Tutorials
---------
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------+----------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | ``Color( 1, 1, 1, 1 )`` |
+---------------------------+----------------------------------------------+-------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ColorRect_property_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **color** = ``Color( 1, 1, 1, 1 )``
.. rst-class:: classref-property-setget
- void **set_frame_color** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_frame_color** **(** **)**
The fill color.
::
$ColorRect.color = 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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`