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

Hérite de : Control < CanvasItem < Node < Object

Un contrôle pour afficher du texte brut.

Description

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).

Tutoriels

Démo 2D « Dodge The Creeps »

Propriétés

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`

Méthodes

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

Propriétés du thème

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

Descriptions des propriétés

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()

Drapeaux de trimming des espaces en autowrap. Voir TextServer.BREAK_TRIM_START_EDGE_SPACES et TextServer.BREAK_TRIM_END_EDGE_SPACES pour plus d'informations.

bool clip_text = false 🔗

void set_clip_text(value: bool)
bool is_clipping_text()

Si true, le Label n'affiche que le texte qui rentre à l'intérieur de son rectangle délimitant et coupera le texte horizontalement.

String ellipsis_char = "…" 🔗

void set_ellipsis_char(value: String)
String get_ellipsis_char()

Caractère d’ellipse utilisé pour tronquer du texte.

HorizontalAlignment horizontal_alignment = 0 🔗

void set_horizontal_alignment(value: HorizontalAlignment)
HorizontalAlignment get_horizontal_alignment()

Contrôle l'alignement horizontal du texte. Supporte à gauche, au centre, à droite, ou remplir (aussi connu comme justifié).

BitField[JustificationFlag] justification_flags = 163 🔗

void set_justification_flags(value: BitField[JustificationFlag])
BitField[JustificationFlag] get_justification_flags()

Règles d'alignement du remplissage des lignes.

LabelSettings label_settings 🔗

void set_label_settings(value: LabelSettings)
LabelSettings get_label_settings()

Une ressource LabelSettings qui peut être partagée entre plusieurs nœuds Label. Prend la priorité sur les propriétés du thème.

String language = "" 🔗

void set_language(value: String)
String get_language()

Code de langue utilisé pour les algorithmes de retour à la ligne et de "text shaping". Si laissé vide, la langue actuelle est utilisée à la place.

int lines_skipped = 0 🔗

void set_lines_skipped(value: int)
int get_lines_skipped()

Le nombre de lignes ignorées et non affichées depuis le début de la valeur de text.

int max_lines_visible = -1 🔗

void set_max_lines_visible(value: int)
int get_max_lines_visible()

Limite le nombre de lignes de texte que le nœud affiche à l'écran.

String paragraph_separator = "\\n" 🔗

void set_paragraph_separator(value: String)
String get_paragraph_separator()

Chaîne utilisée comme séparateur de paragraphe. Chaque paragraphe est traité indépendamment, dans son propre contexte BiDi.

StructuredTextParser structured_text_bidi_override = 0 🔗

void set_structured_text_bidi_override(value: StructuredTextParser)
StructuredTextParser get_structured_text_bidi_override()

Définit la redéfinition de l'algorithme BiDi pour le texte structuré.

Array structured_text_bidi_override_options = [] 🔗

void set_structured_text_bidi_override_options(value: Array)
Array get_structured_text_bidi_override_options()

Définit des options supplémentaires pour la redéfinition BiDi.

PackedFloat32Array tab_stops = PackedFloat32Array() 🔗

void set_tab_stops(value: PackedFloat32Array)
PackedFloat32Array get_tab_stops()

Aligns text to the given 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()

Le texte à afficher à l'écran.

TextDirection text_direction = 0 🔗

void set_text_direction(value: TextDirection)
TextDirection get_text_direction()

Direction d'écriture du texte de base.

OverrunBehavior text_overrun_behavior = 0 🔗

void set_text_overrun_behavior(value: OverrunBehavior)
OverrunBehavior get_text_overrun_behavior()

Le comportement de coupure lorsque le texte dépasse le rectangle délimitant du nœud.

bool uppercase = false 🔗

void set_uppercase(value: bool)
bool is_uppercase()

Si true, tous les textes seront en MAJUSCULE.

VerticalAlignment vertical_alignment = 0 🔗

void set_vertical_alignment(value: VerticalAlignment)
VerticalAlignment get_vertical_alignment()

Contrôle l'alignement vertical du texte. Supporte en haut, au centre, en bas et remplir.

int visible_characters = -1 🔗

void set_visible_characters(value: int)
int get_visible_characters()

Le nombre de caractères à afficher. Si défini à -1, tous les caractères sont affichés. Cela peut être utile lors de l'animation d'un texte apparaissant dans une boîte de dialogue.

Note : Définir cette propriété met à jour visible_ratio en conséquence.

Note : Les caractères sont comptés comme des codes Unicode. Un seul graphème visible peut contenir plusieurs points de code (par exemple, certains emojis utilisent trois points de code). Un seul point de code peut contenir deux caractères UTF-16, qui sont utilisés dans les chaînes C#.

VisibleCharactersBehavior visible_characters_behavior = 0 🔗

void set_visible_characters_behavior(value: VisibleCharactersBehavior)
VisibleCharactersBehavior get_visible_characters_behavior()

Le comportement de coupure lorsque visible_characters ou visible_ratio est défini.

float visible_ratio = 1.0 🔗

void set_visible_ratio(value: float)
float get_visible_ratio()

La fraction des caractères à afficher, par rapport au nombre total de caractères (voir get_total_character_count()). Si défini à 1.0, tous les caractères sont affichés. Si défini à 0.5, seulement la moitié des caractères seront affichés. Cela peut être utile lors de l'animation du texte apparaissant dans une boîte de dialogue.

Note : Définir cette propriété met à jour visible_characters en conséquence.

Descriptions des méthodes

Rect2 get_character_bounds(pos: int) const 🔗

Renvoie le rectangle délimitant du caractère en position pos dans le système de coordonnées local de l'étiquette. Si le caractère est un caractère non-visuel ou pos est hors de la plage valide, un Rect2 vide est renvoyé. Si le caractère fait partie d'un graphème composite, le rectangle délimitant de l'ensemble du graphème est renvoyé.

int get_line_count() const 🔗

Renvoie le nombre de lignes de texte qu'a le Label.

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

Renvoie la hauteur de la ligne line.

Si line est définie à -1, renvoie la plus grande hauteur de ligne.

S'il n'y a pas de lignes, renvoie la taille de police en pixels.

int get_total_character_count() const 🔗

Renvoie le nombre total de caractères affichables dans le texte (sauf les espaces et les nouvelles lignes).

int get_visible_line_count() const 🔗

Renvoie le nombre de lignes affichées. Utile si la hauteur du Label ne peut pas afficher actuellement toutes les lignes.

Descriptions des propriétés du thème

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

La Color par défaut du texte du Label.

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

La couleur du contour du texte.

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

La Color de l'ombre du texte.

int line_spacing = 3 🔗

Espacement vertical supplémentaire entre les lignes (en pixels), l'espacement est ajouté à la descente de la ligne. Cette valeur peut être négative.

int outline_size = 0 🔗

Taille du contour du texte.

Note : Si vous utilisez une police avec FontFile.multichannel_signed_distance_field activé, sa propriété FontFile.msdf_pixel_range doit être définie à au moins deux fois la valeur de outline_size pour que le rendu des contours soit correct. Sinon, le contour peut sembler coupé plus tôt que prévu.

Note : L'utilisation d'une valeur supérieure à la moitié de la taille de la police n'est pas recommandée, car le contour de la police peut échouer à être entièrement fermé dans ce cas.

int paragraph_spacing = 0 🔗

Espace vertical entre les paragraphes. Ajouté en plus de line_spacing.

int shadow_offset_x = 1 🔗

Le décalage horizontal de l'ombre du texte.

int shadow_offset_y = 1 🔗

Le décalage vertical de l'ombre du texte.

int shadow_outline_size = 1 🔗

La taille du contour d'ombre.

Font font 🔗

Font utilisée pour le texte du Label.

int font_size 🔗

Taille de police du texte de Label.

StyleBox focus 🔗

StyleBox utilisé quand le Label a le focus (lorsqu'utilisé avec des applications d’assistance).

StyleBox normal 🔗

Le StyleBox d'arrière-plan pour le Label.