.. 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/docs/gdscript/doc/classes/Label.xml. .. _class_Label: Label ===== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ellipsis_char` | ``"…"`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`justification_flags` | ``163`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`LabelSettings` | :ref:`label_settings` | | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`int` | :ref:`lines_skipped` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_lines_visible` | ``-1`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`MouseFilter` | mouse_filter | ``2`` (overrides :ref:`Control`) | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``4`` (overrides :ref:`Control`) | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`tab_stops` | ``PackedFloat32Array()`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`text` | ``""`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`OverrunBehavior` | :ref:`text_overrun_behavior` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`uppercase` | ``false`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`VerticalAlignment` | :ref:`vertical_alignment` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`int` | :ref:`visible_characters` | ``-1`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`VisibleCharactersBehavior` | :ref:`visible_characters_behavior` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`visible_ratio` | ``1.0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_character_bounds` **(** :ref:`int` pos **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_height` **(** :ref:`int` line=-1 **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`font_shadow_color` | ``Color(0, 0, 0, 0)`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`line_spacing` | ``3`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`shadow_offset_x` | ``1`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`shadow_offset_y` | ``1`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`shadow_outline_size` | ``1`` | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Label_property_autowrap_mode: .. rst-class:: classref-property :ref:`AutowrapMode` **autowrap_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** - :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_clip_text: .. rst-class:: classref-property :ref:`bool` **clip_text** = ``false`` .. rst-class:: classref-property-setget - void **set_clip_text** **(** :ref:`bool` value **)** - :ref:`bool` **is_clipping_text** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_ellipsis_char: .. rst-class:: classref-property :ref:`String` **ellipsis_char** = ``"…"`` .. rst-class:: classref-property-setget - void **set_ellipsis_char** **(** :ref:`String` value **)** - :ref:`String` **get_ellipsis_char** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_horizontal_alignment: .. rst-class:: classref-property :ref:`HorizontalAlignment` **horizontal_alignment** = ``0`` .. rst-class:: classref-property-setget - void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** - :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_justification_flags: .. rst-class:: classref-property |bitfield|\<:ref:`JustificationFlag`\> **justification_flags** = ``163`` .. rst-class:: classref-property-setget - void **set_justification_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** - |bitfield|\<:ref:`JustificationFlag`\> **get_justification_flags** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_label_settings: .. rst-class:: classref-property :ref:`LabelSettings` **label_settings** .. rst-class:: classref-property-setget - void **set_label_settings** **(** :ref:`LabelSettings` value **)** - :ref:`LabelSettings` **get_label_settings** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_language: .. rst-class:: classref-property :ref:`String` **language** = ``""`` .. rst-class:: classref-property-setget - void **set_language** **(** :ref:`String` value **)** - :ref:`String` **get_language** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_lines_skipped: .. rst-class:: classref-property :ref:`int` **lines_skipped** = ``0`` .. rst-class:: classref-property-setget - void **set_lines_skipped** **(** :ref:`int` value **)** - :ref:`int` **get_lines_skipped** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_max_lines_visible: .. rst-class:: classref-property :ref:`int` **max_lines_visible** = ``-1`` .. rst-class:: classref-property-setget - void **set_max_lines_visible** **(** :ref:`int` value **)** - :ref:`int` **get_max_lines_visible** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_structured_text_bidi_override: .. rst-class:: classref-property :ref:`StructuredTextParser` **structured_text_bidi_override** = ``0`` .. rst-class:: classref-property-setget - void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** - :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_structured_text_bidi_override_options: .. rst-class:: classref-property :ref:`Array` **structured_text_bidi_override_options** = ``[]`` .. rst-class:: classref-property-setget - void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** - :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_tab_stops: .. rst-class:: classref-property :ref:`PackedFloat32Array` **tab_stops** = ``PackedFloat32Array()`` .. rst-class:: classref-property-setget - void **set_tab_stops** **(** :ref:`PackedFloat32Array` value **)** - :ref:`PackedFloat32Array` **get_tab_stops** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_text: .. rst-class:: classref-property :ref:`String` **text** = ``""`` .. rst-class:: classref-property-setget - void **set_text** **(** :ref:`String` value **)** - :ref:`String` **get_text** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_text_direction: .. rst-class:: classref-property :ref:`TextDirection` **text_direction** = ``0`` .. rst-class:: classref-property-setget - void **set_text_direction** **(** :ref:`TextDirection` value **)** - :ref:`TextDirection` **get_text_direction** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_text_overrun_behavior: .. rst-class:: classref-property :ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` .. rst-class:: classref-property-setget - void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior` value **)** - :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_uppercase: .. rst-class:: classref-property :ref:`bool` **uppercase** = ``false`` .. rst-class:: classref-property-setget - void **set_uppercase** **(** :ref:`bool` value **)** - :ref:`bool` **is_uppercase** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_vertical_alignment: .. rst-class:: classref-property :ref:`VerticalAlignment` **vertical_alignment** = ``0`` .. rst-class:: classref-property-setget - void **set_vertical_alignment** **(** :ref:`VerticalAlignment` value **)** - :ref:`VerticalAlignment` **get_vertical_alignment** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_visible_characters: .. rst-class:: classref-property :ref:`int` **visible_characters** = ``-1`` .. rst-class:: classref-property-setget - void **set_visible_characters** **(** :ref:`int` value **)** - :ref:`int` **get_visible_characters** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_visible_characters_behavior: .. rst-class:: classref-property :ref:`VisibleCharactersBehavior` **visible_characters_behavior** = ``0`` .. rst-class:: classref-property-setget - void **set_visible_characters_behavior** **(** :ref:`VisibleCharactersBehavior` value **)** - :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_property_visible_ratio: .. rst-class:: classref-property :ref:`float` **visible_ratio** = ``1.0`` .. rst-class:: classref-property-setget - void **set_visible_ratio** **(** :ref:`float` value **)** - :ref:`float` **get_visible_ratio** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Label_method_get_character_bounds: .. rst-class:: classref-method :ref:`Rect2` **get_character_bounds** **(** :ref:`int` pos **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_method_get_line_count: .. rst-class:: classref-method :ref:`int` **get_line_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_method_get_line_height: .. rst-class:: classref-method :ref:`int` **get_line_height** **(** :ref:`int` line=-1 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_method_get_total_character_count: .. rst-class:: classref-method :ref:`int` **get_total_character_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_method_get_visible_line_count: .. rst-class:: classref-method :ref:`int` **get_visible_line_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_Label_theme_color_font_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_color_font_outline_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_outline_color** = ``Color(0, 0, 0, 1)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_color_font_shadow_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_shadow_color** = ``Color(0, 0, 0, 0)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_constant_line_spacing: .. rst-class:: classref-themeproperty :ref:`int` **line_spacing** = ``3`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_constant_outline_size: .. rst-class:: classref-themeproperty :ref:`int` **outline_size** = ``0`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_constant_shadow_offset_x: .. rst-class:: classref-themeproperty :ref:`int` **shadow_offset_x** = ``1`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_constant_shadow_offset_y: .. rst-class:: classref-themeproperty :ref:`int` **shadow_offset_y** = ``1`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_constant_shadow_outline_size: .. rst-class:: classref-themeproperty :ref:`int` **shadow_outline_size** = ``1`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_font_font: .. rst-class:: classref-themeproperty :ref:`Font` **font** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_font_size_font_size: .. rst-class:: classref-themeproperty :ref:`int` **font_size** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Label_theme_style_normal: .. rst-class:: classref-themeproperty :ref:`StyleBox` **normal** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`