class_colorrect.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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. Colored rectangle.
  11. Description
  12. -----------
  13. 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.
  14. Tutorials
  15. ---------
  16. - `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
  17. Properties
  18. ----------
  19. +---------------------------+----------------------------------------------+-----------------------+
  20. | :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | ``Color(1, 1, 1, 1)`` |
  21. +---------------------------+----------------------------------------------+-----------------------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_ColorRect_property_color:
  25. - :ref:`Color<class_Color>` **color**
  26. +-----------+-----------------------+
  27. | *Default* | ``Color(1, 1, 1, 1)`` |
  28. +-----------+-----------------------+
  29. | *Setter* | set_color(value) |
  30. +-----------+-----------------------+
  31. | *Getter* | get_color() |
  32. +-----------+-----------------------+
  33. The fill color.
  34. .. tabs::
  35. .. code-tab:: gdscript
  36. $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red.
  37. .. code-tab:: csharp
  38. GetNode<ColorRect>("ColorRect").Color = new Color(1, 0, 0, 1); // Set ColorRect's color to red.
  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.)`