Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Label

Успадковує: Control < CanvasItem < Node < Object

Контроль для відображення простого тексту.

Опис

Елемент управління для відображення простого тексту. Він дозволяє керувати горизонтальним і вертикальним вирівнюванням, а також забезпечує перенесення тексту в межах обмежувального прямокутника вузла. Він не підтримує жирний шрифт, курсив та інші функції форматування розширеного тексту. Для цього слід використовувати RichTextLabel.

Примітка: Один вузол Label не призначений для відображення великого обсягу тексту. Щоб відобразити великий обсяг тексту в одному вузлі, рекомендуємо використовувати RichTextLabel, оскільки він підтримує такі функції, як вбудована смуга прокрутки та нитки. RichTextLabel зазвичай працює краще при відображенні великого обсягу тексту (кілька сторінок або більше).

Посібники

Властивості

AutowrapMode

autowrap_mode

0

BitField[LineBreakFlag]

autowrap_trim_flags

192

bool

clip_text

false

String

ellipsis_char

"…"

HorizontalAlignment

horizontal_alignment

0

BitField[JustificationFlag]

justification_flags

163

LabelSettings

label_settings

String

language

""

int

lines_skipped

0

int

max_lines_visible

-1

MouseFilter

mouse_filter

2 (overrides Control)

String

paragraph_separator

"\\n"

BitField[SizeFlags]

size_flags_vertical

4 (overrides Control)

StructuredTextParser

structured_text_bidi_override

0

Array

structured_text_bidi_override_options

[]

PackedFloat32Array

tab_stops

PackedFloat32Array()

String

text

""

TextDirection

text_direction

0

OverrunBehavior

text_overrun_behavior

0

bool

uppercase

false

VerticalAlignment

vertical_alignment

0

int

visible_characters

-1

VisibleCharactersBehavior

visible_characters_behavior

0

float

visible_ratio

1.0

Методи

Rect2

get_character_bounds(pos: int) const

int

get_line_count() const

int

get_line_height(line: int = -1) const

int

get_total_character_count() const

int

get_visible_line_count() const

Властивості теми

Color

font_color

Color(1, 1, 1, 1)

Color

font_outline_color

Color(0, 0, 0, 1)

Color

font_shadow_color

Color(0, 0, 0, 0)

int

line_spacing

3

int

outline_size

0

int

paragraph_spacing

0

int

shadow_offset_x

1

int

shadow_offset_y

1

int

shadow_outline_size

1

Font

font

int

font_size

StyleBox

focus

StyleBox

normal

Описи властивостей

AutowrapMode autowrap_mode = 0 🔗

  • void set_autowrap_mode(value: AutowrapMode)

  • AutowrapMode get_autowrap_mode()

If set to something other than TextServer.AUTOWRAP_OFF, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text.

Note: Labels with autowrapping enabled must have a custom maximum width configured to work correctly, either through the Label's own Control.custom_maximum_size or as a result of a propagated maximum size from a parent Control with Control.propagate_maximum_size enabled.

BitField[LineBreakFlag] autowrap_trim_flags = 192 🔗

  • void set_autowrap_trim_flags(value: BitField[LineBreakFlag])

  • BitField[LineBreakFlag] get_autowrap_trim_flags()

Прапорці обрізання пробілів при автоматичному перенесенні. Див. TextServer.BREAK_TRIM_START_EDGE_SPACES та TextServer.BREAK_TRIM_END_EDGE_SPACES для отримання додаткової інформації.

bool clip_text = false 🔗

  • void set_clip_text(value: bool)

  • bool is_clipping_text()

Якщо true, Етикетка показує текст, який вписується всередині його межі прямокутника і буде натискати текст горизонтально.

String ellipsis_char = "…" 🔗

  • void set_ellipsis_char(value: String)

  • String get_ellipsis_char()

Елліпсис характер використовується для текстового затиску.

HorizontalAlignment horizontal_alignment = 0 🔗

Керує горизонтальним вирівнюванням тексту. Підтримує вирівнювання по лівому краю, по центру, по правому краю та заповнення (також відоме як вирівнювання по ширині).

BitField[JustificationFlag] justification_flags = 163 🔗

  • void set_justification_flags(value: BitField[JustificationFlag])

  • BitField[JustificationFlag] get_justification_flags()

Правила вирівнювання заповнення рядків.

LabelSettings label_settings 🔗

LabelSettings ресурс, який може бути розділений між декількома вузлами Label. Взяти пріоритет за темними властивостями.

String language = "" 🔗

  • void set_language(value: String)

  • String get_language()

Код мови, що використовується для алгоритмів розриву рядків та формування тексту. Якщо залишити поле порожнім, використовується поточна локалізація.

int lines_skipped = 0 🔗

  • void set_lines_skipped(value: int)

  • int get_lines_skipped()

Кількість рядків, що проігноровані та не відображаються з початку значення text.

int max_lines_visible = -1 🔗

  • void set_max_lines_visible(value: int)

  • int get_max_lines_visible()

Увімкніть рядки текстового вузла на екрані.

String paragraph_separator = "\\n" 🔗

  • void set_paragraph_separator(value: String)

  • String get_paragraph_separator()

Рядок, який використовується як роздільник абзаців. Кожен абзац обробляється незалежно, у власному контексті BiDi.

StructuredTextParser structured_text_bidi_override = 0 🔗

  • void set_structured_text_bidi_override(value: StructuredTextParser)

  • StructuredTextParser get_structured_text_bidi_override()

Настроювання алгоритму BiDi для структурованого тексту.

Array structured_text_bidi_override_options = [] 🔗

  • void set_structured_text_bidi_override_options(value: Array)

  • Array get_structured_text_bidi_override_options()

Налаштуйте додаткові параметри для перенади BiDi.

PackedFloat32Array tab_stops = PackedFloat32Array() 🔗

  • void set_tab_stops(value: PackedFloat32Array)

  • PackedFloat32Array get_tab_stops()

Вирівнює текст на задану вкладку.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedFloat32Array for more details.

String text = "" 🔗

  • void set_text(value: String)

  • String get_text()

Текст відображення на екрані.

TextDirection text_direction = 0 🔗

Основний напрямок написання тексту.

OverrunBehavior text_overrun_behavior = 0 🔗

  • void set_text_overrun_behavior(value: OverrunBehavior)

  • OverrunBehavior get_text_overrun_behavior()

Поведінка відсікання, коли текст виходить за межі обмежувального прямокутника вузла.

bool uppercase = false 🔗

  • void set_uppercase(value: bool)

  • bool is_uppercase()

Якщо true, всі текстові дисплеї як UPPERCASE.

VerticalAlignment vertical_alignment = 0 🔗

Керує вертикальним вирівнюванням тексту. Підтримує вирівнювання по верху, по центру, знизу та заливку.

int visible_characters = -1 🔗

  • void set_visible_characters(value: int)

  • int get_visible_characters()

Кількість символів для відображення. Якщо встановлено значення -1, відображаються всі символи. Це може бути корисно під час анімації тексту, що з'являється у діалоговому вікні.

Примітка: Встановлення цього параметра відповідно оновлює visible_ratio.

Примітка: Символи підраховуються як кодові точки Unicode. Один видимий графема може містити кілька кодових точок (наприклад, деякі емодзі використовують три кодові точки). Одна кодова точка може містити два символи UTF-16, які використовуються в рядках C#.

VisibleCharactersBehavior visible_characters_behavior = 0 🔗

  • void set_visible_characters_behavior(value: VisibleCharactersBehavior)

  • VisibleCharactersBehavior get_visible_characters_behavior()

Поведінка відсікання, коли встановлено visible_characters або visible_ratio.

float visible_ratio = 1.0 🔗

  • void set_visible_ratio(value: float)

  • float get_visible_ratio()

Факт символів для відображення, відносно загальної кількості символів (див. get_total_character_count()). Якщо встановити на 1.0, всі символи відображаються. Якщо встановити до 0.5, буде показано лише половину символів. Це може бути корисно, коли анімація тексту з'являється в діалоговому вікні.

Примітка: Встановлення оновлень цього майна visible_characters відповідно.

Описи методів

Rect2 get_character_bounds(pos: int) const 🔗

Повертає обмежувальний прямокутник символу в позиції pos у локальній системі координат мітки. Якщо символ є невізуальним або pos знаходиться за межами допустимого діапазону, повертається порожній Rect2. Якщо символ є частиною складеної графеми, повертається обмежувальний прямокутник усієї графеми.

int get_line_count() const 🔗

Повертає кількість рядків тексту, що має етикетку.

int get_line_height(line: int = -1) const 🔗

Повертає висоту лінії line.

-1, повертає найбільшу висоту лінії.

Якщо немає рядків, повертає розмір шрифту у пікселях.

int get_total_character_count() const 🔗

Повертає загальну кількість друкованих символів у тексті (за винятком пробілів та нових ліній).

int get_visible_line_count() const 🔗

Повертаємо кількість виділених ліній. Якщо висота Label не може відображати всі лінії.

Описи тематичної нерухомості

Color font_color = Color(1, 1, 1, 1) 🔗

Текст за замовчуванням Color Label.

Color font_outline_color = Color(0, 0, 0, 1) 🔗

Колір текстів.

Color font_shadow_color = Color(0, 0, 0, 0) 🔗

Color ефекту тіні тексту.

int line_spacing = 3 🔗

Додатковий вертикальний інтервал між рядками (у пікселях), інтервал додається до рядкового спуску. Це значення може бути негативним.

int outline_size = 0 🔗

Розмір контуру тексту.

Примітка: Якщо за допомогою шрифту FontFile.multiканал_signed_distance_field ввімкнено, його FontFile.msdf_pixel_range необхідно встановити принаймні twice значення index_size для позначення, що дає змогу виглядати правильно. В іншому випадку контур може з'явитися, щоб зрізати раніше, ніж призначений.

Примітка: Використання значення, яке більше половини розмір шрифту не рекомендується, оскільки контур шрифту може бути повністю закритий в цьому випадку.

int paragraph_spacing = 0 🔗

Вертикальний інтервал між абзацами. Додано поверх line_spacing.

int shadow_offset_x = 1 🔗

Горизонтальний зсув тіні тексту.

int shadow_offset_y = 1 🔗

Вертикальний зсув тіні тексту.

int shadow_outline_size = 1 🔗

Розмір контуру тіні.

Font font 🔗

Font використовується для тексту Label.

int font_size 🔗

Розмір шрифту тексту Label.

StyleBox focus 🔗

StyleBox використовується, коли фокус увімкнено Ladel (при використанні з допоміжними програмами).

StyleBox normal 🔗

StyleBox для Label.