Label

Inherits: Control < CanvasItem < Node < Object

在一行中显示纯文本，或在一个矩形内包裹。对于格式化的文本，使用RichTextLabel。

描述

标签在屏幕上显示纯文本。可以控制水平和垂直的对齐方式，并且可以将文本包裹在节点的边界矩形内。它不支持粗体、斜体或其他格式。若使用，请改用 RichTextLabel。

注意： 与大多数其他 Control 不同，Label 的 Control.mouse_filter 默认为 Control.MOUSE_FILTER_IGNORE，即它不响应鼠标输入事件。这意味着标签不会显示任何已配置的 Control.hint_tooltip，除非更改其鼠标过滤器。

注意：Windows 上不支持 0xffff 之后的 Unicode 字符，例如大多数表情符号，它们将显示为未知字符。这将在 Godot 4.0 中解决。

教程

属性

Align

align

0

bool

autowrap

false

bool

clip_text

false

int

lines_skipped

0

int

max_lines_visible

-1

MouseFilter

mouse_filter

2 (overrides Control)

float

percent_visible

1.0

int

size_flags_vertical

4 (overrides Control)

String

text

“”

bool

uppercase

false

VAlign

valign

0

int

visible_characters

-1

方法

int

get_line_count ( ) const

int

get_line_height ( ) const

int

get_total_character_count ( ) const

int

get_visible_line_count ( ) const

主题属性

Color

font_color

Color( 1, 1, 1, 1 )

Color

font_color_shadow

Color( 0, 0, 0, 0 )

Color

font_outline_modulate

Color( 1, 1, 1, 1 )

int

line_spacing

3

int

shadow_as_outline

0

int

shadow_offset_x

1

int

shadow_offset_y

1

Font

font

StyleBox

normal

枚举

enum Align:

  • ALIGN_LEFT = 0 —- 将行左对齐，默认。

  • ALIGN_CENTER = 1 —- 居中对齐行。

  • ALIGN_RIGHT = 2 —- 将行向右对齐。

  • ALIGN_FILL = 3 —- 扩展行空白以适应宽度。

enum VAlign:

  • VALIGN_TOP = 0 —- 将整个文本对齐到顶部。

  • VALIGN_CENTER = 1 —- 将整个文本居中对齐。

  • VALIGN_BOTTOM = 2 —- 将整个文本与底部对齐。

  • VALIGN_FILL = 3 —- 通过展开行来对齐整个文本。

属性说明

Default

0

Setter

set_align(value)

Getter

get_align()

控制文本的水平对齐。支持左对齐、居中对齐、右对齐和填充，或者两端对齐。把它设置为Align常量之一。

Default

false

Setter

set_autowrap(value)

Getter

has_autowrap()

如果true，则将文本包裹在节点的边界矩形内。如果你调整节点的大小，它将自动改变其高度以显示所有的文本。

Default

false

Setter

set_clip_text(value)

Getter

is_clipping_text()

如果 true，则标签仅显示适合其边界矩形的文本，并将水平剪切文本。

  • int lines_skipped

Default

0

Setter

set_lines_skipped(value)

Getter

get_lines_skipped()

该节点在开始显示文本之前会忽略前 lines_skipped 行。

  • int max_lines_visible

Default

-1

Setter

set_max_lines_visible(value)

Getter

get_max_lines_visible()

限制节点在屏幕上显示的文本行数。

Default

1.0

Setter

set_percent_visible(value)

Getter

get_percent_visible()

限制可见字符的数量。如果你把%_visible设置为0.5，屏幕上最多只能显示文本的一半字符。这在对话框中对文本进行动画处理很有用。

Default

“”

Setter

set_text(value)

Getter

get_text()

要在屏幕上显示的文本。

Default

false

Setter

set_uppercase(value)

Getter

is_uppercase()

如果 true，则所有文本都显示为大写。

Default

0

Setter

set_valign(value)

Getter

get_valign()

控制文本的垂直对齐。支持顶部、中心、底部和填充。参阅VAlign常数。

  • int visible_characters

Default

-1

Setter

set_visible_characters(value)

Getter

get_visible_characters()

限制显示的字符数。设置为-1表示禁用限制。

方法说明

  • int get_line_count ( ) const

返回Label标签的文本行数。

  • int get_line_height ( ) const

返回字体大小，单位是像素。

  • int get_total_character_count ( ) const

返回文本中可打印的字符总数，不包括空格和换行符。

  • int get_visible_line_count ( ) const

返回显示的行数。如果Label的高度目前无法显示所有的行数，将会有用。

Theme Property Descriptions

Default

Color( 1, 1, 1, 1 )

Label标签的默认文本颜色Color。

Default

Color( 0, 0, 0, 0 )

文本阴影效果的颜色Color。

  • Color font_outline_modulate

Default

Color( 1, 1, 1, 1 )

Font轮廓的色调。参阅DynamicFont.outline_color。

  • int line_spacing

Default

3

多行Label中各行之间的垂直空间。

  • int shadow_as_outline

Default

0

布尔值。如果设置为1，即true，整个文本周围显示阴影轮廓。

  • int shadow_offset_x

Default

1

文本阴影的水平偏移。

  • int shadow_offset_y

Default

1

文本阴影的垂直偏移。

用于标签Label文本的字体Font。

为Label设置背景样式StyleBox。