class_colorrect.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorRect.xml.
  6. .. _class_ColorRect:
  7. ColorRect
  8. =========
  9. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A control that displays a solid color rectangle.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Displays a rectangle filled with a solid :ref:`color<class_ColorRect_property_color>`. If you need to display the border alone, consider using a :ref:`Panel<class_Panel>` instead.
  15. .. rst-class:: classref-introduction-group
  16. Tutorials
  17. ---------
  18. - `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/2712>`__
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +---------------------------+----------------------------------------------+-----------------------+
  25. | :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | ``Color(1, 1, 1, 1)`` |
  26. +---------------------------+----------------------------------------------+-----------------------+
  27. .. rst-class:: classref-section-separator
  28. ----
  29. .. rst-class:: classref-descriptions-group
  30. Property Descriptions
  31. ---------------------
  32. .. _class_ColorRect_property_color:
  33. .. rst-class:: classref-property
  34. :ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ColorRect_property_color>`
  35. .. rst-class:: classref-property-setget
  36. - |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
  37. - :ref:`Color<class_Color>` **get_color**\ (\ )
  38. The fill color of the rectangle.
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  42. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  43. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  44. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  45. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  46. .. |void| replace:: :abbr:`void (No return value.)`