Files
godot-docs/classes/class_labelsettings.rst
2022-11-17 21:03:53 +01:00

209 lines
8.3 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>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
+-------------------------------+------------------------------------------------------------------+-----------------------+
| :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`` |
+-------------------------------+------------------------------------------------------------------+-----------------------+
Property Descriptions
---------------------
.. _class_LabelSettings_property_font:
- :ref:`Font<class_Font>` **font**
+----------+-----------------+
| *Setter* | set_font(value) |
+----------+-----------------+
| *Getter* | get_font() |
+----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_font_color:
- :ref:`Color<class_Color>` **font_color**
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
| *Setter* | set_font_color(value) |
+-----------+-----------------------+
| *Getter* | get_font_color() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_font_size:
- :ref:`int<class_int>` **font_size**
+-----------+----------------------+
| *Default* | ``16`` |
+-----------+----------------------+
| *Setter* | set_font_size(value) |
+-----------+----------------------+
| *Getter* | get_font_size() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_line_spacing:
- :ref:`float<class_float>` **line_spacing**
+-----------+-------------------------+
| *Default* | ``3.0`` |
+-----------+-------------------------+
| *Setter* | set_line_spacing(value) |
+-----------+-------------------------+
| *Getter* | get_line_spacing() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_outline_color:
- :ref:`Color<class_Color>` **outline_color**
+-----------+--------------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+--------------------------+
| *Setter* | set_outline_color(value) |
+-----------+--------------------------+
| *Getter* | get_outline_color() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_outline_size:
- :ref:`int<class_int>` **outline_size**
+-----------+-------------------------+
| *Default* | ``0`` |
+-----------+-------------------------+
| *Setter* | set_outline_size(value) |
+-----------+-------------------------+
| *Getter* | get_outline_size() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_shadow_color:
- :ref:`Color<class_Color>` **shadow_color**
+-----------+-------------------------+
| *Default* | ``Color(0, 0, 0, 0)`` |
+-----------+-------------------------+
| *Setter* | set_shadow_color(value) |
+-----------+-------------------------+
| *Getter* | get_shadow_color() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_shadow_offset:
- :ref:`Vector2<class_Vector2>` **shadow_offset**
+-----------+--------------------------+
| *Default* | ``Vector2(1, 1)`` |
+-----------+--------------------------+
| *Setter* | set_shadow_offset(value) |
+-----------+--------------------------+
| *Getter* | get_shadow_offset() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_LabelSettings_property_shadow_size:
- :ref:`int<class_int>` **shadow_size**
+-----------+------------------------+
| *Default* | ``1`` |
+-----------+------------------------+
| *Setter* | set_shadow_size(value) |
+-----------+------------------------+
| *Getter* | get_shadow_size() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`