mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
216 lines
7.6 KiB
ReStructuredText
216 lines
7.6 KiB
ReStructuredText
: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/LabelSettings.xml.
|
|
|
|
.. _class_LabelSettings:
|
|
|
|
LabelSettings
|
|
=============
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Provides common settings to customize the text in a :ref:`Label<class_Label>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
**LabelSettings** is a resource that provides common settings to customize the text in a :ref:`Label<class_Label>`. It will take priority over the properties defined in :ref:`Control.theme<class_Control_property_theme>`. The resource can be shared between multiple labels and changed on the fly, so it's convenient and flexible way to setup text style.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_LabelSettings_property_font>` | |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_LabelSettings_property_font_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`font_size<class_LabelSettings_property_font_size>` | ``16`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`line_spacing<class_LabelSettings_property_line_spacing>` | ``3.0`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`outline_color<class_LabelSettings_property_outline_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`outline_size<class_LabelSettings_property_outline_size>` | ``0`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`shadow_color<class_LabelSettings_property_shadow_color>` | ``Color(0, 0, 0, 0)`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`shadow_offset<class_LabelSettings_property_shadow_offset>` | ``Vector2(1, 1)`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`shadow_size<class_LabelSettings_property_shadow_size>` | ``1`` |
|
|
+-------------------------------+------------------------------------------------------------------+-----------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_LabelSettings_property_font:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Font<class_Font>` **font**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_font** **(** :ref:`Font<class_Font>` value **)**
|
|
- :ref:`Font<class_Font>` **get_font** **(** **)**
|
|
|
|
:ref:`Font<class_Font>` used for the text.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_font_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Color<class_Color>` **font_color** = ``Color(1, 1, 1, 1)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_font_color** **(** :ref:`Color<class_Color>` value **)**
|
|
- :ref:`Color<class_Color>` **get_font_color** **(** **)**
|
|
|
|
Color of the text.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_font_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **font_size** = ``16``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_font_size** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_font_size** **(** **)**
|
|
|
|
Size of the text.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_line_spacing:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **line_spacing** = ``3.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_line_spacing** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_line_spacing** **(** **)**
|
|
|
|
Vertical space between lines when the text is multiline.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_outline_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Color<class_Color>` **outline_color** = ``Color(1, 1, 1, 1)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_outline_color** **(** :ref:`Color<class_Color>` value **)**
|
|
- :ref:`Color<class_Color>` **get_outline_color** **(** **)**
|
|
|
|
The color of the outline.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_outline_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **outline_size** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_outline_size** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_outline_size** **(** **)**
|
|
|
|
Text outline size.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_shadow_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Color<class_Color>` **shadow_color** = ``Color(0, 0, 0, 0)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_shadow_color** **(** :ref:`Color<class_Color>` value **)**
|
|
- :ref:`Color<class_Color>` **get_shadow_color** **(** **)**
|
|
|
|
Color of the shadow effect. If alpha is ``0``, no shadow will be drawn.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_shadow_offset:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **shadow_offset** = ``Vector2(1, 1)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_shadow_offset** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **get_shadow_offset** **(** **)**
|
|
|
|
Offset of the shadow effect, in pixels.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_LabelSettings_property_shadow_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **shadow_size** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_shadow_size** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_shadow_size** **(** **)**
|
|
|
|
Size of the shadow effect.
|
|
|
|
.. |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.)`
|