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

Eredita: Control < CanvasItem < Node < Object

Un controllo per visualizzare testo semplice.

Descrizione

A control for displaying plain text. It gives you control over the horizontal and vertical alignment and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics, or other rich text formatting. For that, use RichTextLabel instead.

Note: A single Label node is not designed to display huge amounts of text. To display large amounts of text in a single node, consider using RichTextLabel instead as it supports features like an integrated scroll bar and threading. RichTextLabel generally performs better when displaying large amounts of text (several pages or more).

Tutorial

Proprietà

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

Metodi

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

Proprietà del tema

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

Descrizioni delle proprietà

AutowrapMode autowrap_mode = 0 🔗

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 🔗

Flag di troncamento spazi per il ritorno a capo automatico. Vedi TextServer.BREAK_TRIM_START_EDGE_SPACES e TextServer.BREAK_TRIM_END_EDGE_SPACES per ulteriori informazioni.

bool clip_text = false 🔗

  • void set_clip_text(value: bool)

  • bool is_clipping_text()

Se true, l'etichetta mostra solo il testo che rientra nel rettangolo di delimitazione e ritaglia il testo orizzontalmente.

String ellipsis_char = "…" 🔗

  • void set_ellipsis_char(value: String)

  • String get_ellipsis_char()

Carattere di ellissi (puntini di sospensione) utilizzato per ritagliare il testo.

HorizontalAlignment horizontal_alignment = 0 🔗

Controlla l'allineamento orizzontale del testo. Supporta sinistra, centro, destra, e riempi (noto anche come giustifica).

BitField[JustificationFlag] justification_flags = 163 🔗

Regole di allineamento del riempimento per le righe.

LabelSettings label_settings 🔗

Una risorsa LabelSettings che può essere condivisa tra più nodi Label. Ha la priorità sulle proprietà del tema.

String language = "" 🔗

Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.

int lines_skipped = 0 🔗

  • void set_lines_skipped(value: int)

  • int get_lines_skipped()

Il numero di righe ignorate e non visualizzate dall'inizio del testo (text).

int max_lines_visible = -1 🔗

  • void set_max_lines_visible(value: int)

  • int get_max_lines_visible()

Limita il numero delle righe di testo che il nodo mostra sullo schermo.

String paragraph_separator = "\\n" 🔗

  • void set_paragraph_separator(value: String)

  • String get_paragraph_separator()

Stringa utilizzata come separatore di paragrafo. Ogni paragrafo è elaborato in modo indipendente, nel proprio contesto BiDi.

StructuredTextParser structured_text_bidi_override = 0 🔗

Imposta la sostituzione dell'algoritmo BiDi per il testo strutturato.

Array structured_text_bidi_override_options = [] 🔗

  • void set_structured_text_bidi_override_options(value: Array)

  • Array get_structured_text_bidi_override_options()

Imposta opzioni aggiuntive per la sostituzione BiDi.

PackedFloat32Array tab_stops = PackedFloat32Array() 🔗

Allinea il testo alle tabulazioni specificate.

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 = "" 🔗

Il testo da visualizzare sullo schermo.

TextDirection text_direction = 0 🔗

Direzione di scrittura del testo di base.

OverrunBehavior text_overrun_behavior = 0 🔗

Il comportamento di ritaglio quando il testo supera il rettangolo di delimitazione del nodo.

bool uppercase = false 🔗

  • void set_uppercase(value: bool)

  • bool is_uppercase()

Se true, tutto il testo è visualizzato in MAIUSCOLO.

VerticalAlignment vertical_alignment = 0 🔗

Controlla l'allineamento verticale del testo. Supporta sopra, centro, sotto e riempi.

int visible_characters = -1 🔗

  • void set_visible_characters(value: int)

  • int get_visible_characters()

Il numero di caratteri da visualizzare. Se impostato su -1, tutti i caratteri sono visualizzati. Può essere utile quando si anima il testo che appare in una finestra di dialogo.

Nota: Impostando questa proprietà si aggiorna visible_ratio di conseguenza.

Nota: I caratteri sono conteggiati come codici Unicode. Un singolo grafema visibile può contenere più codici (ad esempio, alcune emoji ne utilizzano tre). Un singolo codice può contenere due caratteri UTF-16, i quali sono utilizzati nelle stringhe C#.

VisibleCharactersBehavior visible_characters_behavior = 0 🔗

Il comportamento di ritaglio quando è impostato visible_characters o visible_ratio.

float visible_ratio = 1.0 🔗

  • void set_visible_ratio(value: float)

  • float get_visible_ratio()

La frazione di caratteri da visualizzare, relativa al numero totale di caratteri (vedi get_total_character_count()). Se impostato su 1.0, sono visualizzati tutti i caratteri. Se impostato su 0.5, sarà visualizzata solo la metà dei caratteri. Questo può essere utile quando si anima il testo che appare in una finestra di dialogo.

Nota: Impostando questa proprietà viene aggiornato visible_characters di conseguenza.

Descrizioni dei metodi

Rect2 get_character_bounds(pos: int) const 🔗

Restituisce il rettangolo di delimitazione del carattere nella posizione pos, nel sistema di coordinate locale dell'etichetta. Se il carattere è un carattere non visivo o pos è al di fuori dell'intervallo valido, viene restituito un Rect2 vuoto. Se il carattere è parte di un grafema composito, è restituito il rettangolo di delimitazione dell'intero grafema.

int get_line_count() const 🔗

Restituisce il numero di righe di testo che l'etichetta ha.

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

Restituisce l'altezza della riga line.

Se line è impostato su -1, restituisce l'altezza della riga più grande.

Se non ci sono righe, restituisce la dimensione del font in pixel.

int get_total_character_count() const 🔗

Restituisce il numero totale di caratteri stampabili nel testo (esclusi spazi e ritorni a capo).

int get_visible_line_count() const 🔗

Restituisce il numero di righe mostrate. Utile se l'altezza del Label non può attualmente visualizzare tutte le righe.

Descrizioni delle proprietà del tema

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

Il Color predefinito del testo del Label.

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

Il Color del contorno del testo.

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

Il Color dell'ombra del testo.

int line_spacing = 3 🔗

Spaziatura verticale aggiuntiva tra le righe (in pixel), la spaziatura è aggiunta alla discesa della riga. Questo valore può essere negativo.

int outline_size = 0 🔗

Dimensione del contorno del testo.

Nota: Se si utilizza un font con FontFile.multichannel_signed_distance_field abilitato, il suo FontFile.msdf_pixel_range deve essere impostato su almeno il doppio del valore di outline_size affinché il rendering del contorno appaia corretto. Altrimenti, il contorno potrebbe apparire troncato prima del previsto.

Nota: Non è consigliato utilizzare un valore maggiore della metà della dimensione del font, altrimenti il contorno del font potrebbe non chiudersi completamente.

int paragraph_spacing = 0 🔗

Spazio verticale tra i paragrafi. Aggiunto assieme a line_spacing.

int shadow_offset_x = 1 🔗

Lo scostamento orizzontale dell'ombra del testo.

int shadow_offset_y = 1 🔗

Lo scostamento verticale dell'ombra del testo.

int shadow_outline_size = 1 🔗

La dimensione del contorno dell'ombra.

Font font 🔗

Font utilizzato per il testo del Label.

int font_size 🔗

Dimensione del font utilizzato per il testo del Label.

StyleBox focus 🔗

StyleBox utilizzato quando il Label è focalizzato (quando utilizzato tramite applicazioni assistive).

StyleBox normal 🔗

Lo StyleBox di sfondo per il Label.