mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
140 lines
5.0 KiB
ReStructuredText
140 lines
5.0 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/StyleBoxLine.xml.
|
|
|
|
.. _class_StyleBoxLine:
|
|
|
|
StyleBoxLine
|
|
============
|
|
|
|
**Inherits:** :ref:`StyleBox<class_StyleBox>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A :ref:`StyleBox<class_StyleBox>` that displays a single line of a given color and thickness.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A :ref:`StyleBox<class_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<class_Color>` | :ref:`color<class_StyleBoxLine_property_color>` | ``Color(0, 0, 0, 1)`` |
|
|
+---------------------------+-----------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`grow_begin<class_StyleBoxLine_property_grow_begin>` | ``1.0`` |
|
|
+---------------------------+-----------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`grow_end<class_StyleBoxLine_property_grow_end>` | ``1.0`` |
|
|
+---------------------------+-----------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`thickness<class_StyleBoxLine_property_thickness>` | ``1`` |
|
|
+---------------------------+-----------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`vertical<class_StyleBoxLine_property_vertical>` | ``false`` |
|
|
+---------------------------+-----------------------------------------------------------+-----------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_StyleBoxLine_property_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Color<class_Color>` **color** = ``Color(0, 0, 0, 1)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_color** **(** :ref:`Color<class_Color>` value **)**
|
|
- :ref:`Color<class_Color>` **get_color** **(** **)**
|
|
|
|
The line's color.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_StyleBoxLine_property_grow_begin:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **grow_begin** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_grow_begin** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_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<class_float>` **grow_end** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_grow_end** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_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<class_int>` **thickness** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_thickness** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_thickness** **(** **)**
|
|
|
|
The line's thickness in pixels.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_StyleBoxLine_property_vertical:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **vertical** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_vertical** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_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.)`
|
|
.. |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.)`
|