Label

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Displays plain text in a line or wrapped inside a rectangle. For formatted text, use RichTextLabel.

Member Functions

int get_line_count ( ) const
int get_line_height ( ) const
int get_total_character_count ( ) const
int get_visible_characters ( ) const
int get_visible_line_count ( ) const
void set_visible_characters ( int amount )

Member Variables

  • int align - Controls the text’s horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ALIGN\_\* constants.
  • bool autowrap - If true, wraps the text inside the node’s bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false.
  • bool clip_text - If true, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely.
  • int lines_skipped - The node ignores the first lines_skipped lines before it starts to display text.
  • int max_lines_visible - Limits the lines of text the node shows on screen.
  • float percent_visible - Limits the count of visible characters. If you set percent_visible to 50, only up to half of the text’s characters will display on screen. Useful to animate the text in a dialog box.
  • String text - The text to display on screen.
  • bool uppercase - If true, all the text displays as UPPERCASE.
  • int valign - Controls the text’s vertical align. Supports top, center, bottom, and fill. Set it to one of the VALIGN\_\* constants.

Numeric Constants

  • ALIGN_LEFT = 0 — Align rows to the left (default).
  • ALIGN_CENTER = 1 — Align rows centered.
  • ALIGN_RIGHT = 2 — Align rows to the right (default).
  • ALIGN_FILL = 3 — Expand row whitespaces to fit the width.
  • VALIGN_TOP = 0 — Align the whole text to the top.
  • VALIGN_CENTER = 1 — Align the whole text to the center.
  • VALIGN_BOTTOM = 2 — Align the whole text to the bottom.
  • VALIGN_FILL = 3 — Align the whole text by spreading the rows.

Description

Label displays plain text on the screen. 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 formatting. For that, use RichTextLabel instead.

Member Function Description

  • int get_line_count ( ) const

Returns the amount of lines of text the Label has.

  • int get_line_height ( ) const

Returns the font size in pixels.

  • int get_total_character_count ( ) const

Returns the total length of the text.

  • int get_visible_characters ( ) const

Returns the restricted number of characters to display. Returns -1 if unrestricted.

  • int get_visible_line_count ( ) const

Returns the number of lines shown. Useful if the Label ‘s height cannot currently display all lines.

  • void set_visible_characters ( int amount )

Restricts the number of characters to display. Set to -1 to disable.