:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxLine.xml. .. _class_StyleBoxLine: StyleBoxLine ============ **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A :ref:`StyleBox` that displays a single line of a given color and thickness. .. rst-class:: classref-introduction-group Description ----------- A :ref:`StyleBox` that displays a single line of a given color and thickness. The line can be either horizontal or vertical. Useful for separators. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | +---------------------------+-----------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`grow_begin` | ``1.0`` | +---------------------------+-----------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`grow_end` | ``1.0`` | +---------------------------+-----------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`thickness` | ``1`` | +---------------------------+-----------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`vertical` | ``false`` | +---------------------------+-----------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_StyleBoxLine_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) The line's color. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxLine_property_grow_begin: .. rst-class:: classref-property :ref:`float` **grow_begin** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_grow_begin**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_grow_begin**\ (\ ) The number of pixels the line will extend before the **StyleBoxLine**'s bounds. If set to a negative value, the line will begin inside the **StyleBoxLine**'s bounds. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxLine_property_grow_end: .. rst-class:: classref-property :ref:`float` **grow_end** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_grow_end**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_grow_end**\ (\ ) The number of pixels the line will extend past the **StyleBoxLine**'s bounds. If set to a negative value, the line will end inside the **StyleBoxLine**'s bounds. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxLine_property_thickness: .. rst-class:: classref-property :ref:`int` **thickness** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_thickness**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_thickness**\ (\ ) The line's thickness in pixels. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxLine_property_vertical: .. rst-class:: classref-property :ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_vertical**\ (\ ) If ``true``, the line will be vertical. If ``false``, the line will be horizontal. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`