LabelSettings

提供能够在 Label 中自定义文本的常见设置。

描述

LabelSettings 是一种提供在 Label 中自定义文本的常见设置的资源。优先于 Control.theme 中定义的属性。该资源可以在多个标签之间共享，可以随时替换，因此可以方便、灵活地设置文本样式。

属性

Font	font
Color	font_color	`Color(1, 1, 1, 1)`
int	font_size	`16`
float	line_spacing	`3.0`
Color	outline_color	`Color(1, 1, 1, 1)`
int	outline_size	`0`
float	paragraph_spacing	`0.0`
Color	shadow_color	`Color(0, 0, 0, 0)`
Vector2	shadow_offset	`Vector2(1, 1)`
int	shadow_size	`1`
int	stacked_outline_count	`0`
int	stacked_shadow_count	`0`

方法

void	add_stacked_outline(index: int = -1)
void	add_stacked_shadow(index: int = -1)
Color	get_stacked_outline_color(index: int) const
int	get_stacked_outline_size(index: int) const
Color	get_stacked_shadow_color(index: int) const
Vector2	get_stacked_shadow_offset(index: int) const
int	get_stacked_shadow_outline_size(index: int) const
void	move_stacked_outline(from_index: int, to_position: int)
void	move_stacked_shadow(from_index: int, to_position: int)
void	remove_stacked_outline(index: int)
void	remove_stacked_shadow(index: int)
void	set_stacked_outline_color(index: int, color: Color)
void	set_stacked_outline_size(index: int, size: int)
void	set_stacked_shadow_color(index: int, color: Color)
void	set_stacked_shadow_offset(index: int, offset: Vector2)
void	set_stacked_shadow_outline_size(index: int, size: int)

属性说明

Font font 🔗

void set_font(value: Font)
Font get_font()

文本使用的 Font。

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

void set_font_color(value: Color)
Color get_font_color()

文本的颜色。

int font_size = 16 🔗

void set_font_size(value: int)
int get_font_size()

文本的大小。

float line_spacing = 3.0 🔗

void set_line_spacing(value: float)
float get_line_spacing()

行与行之间的额外纵向留白（单位为像素），留白会被添加到行的降部。该值可以为负数。

Color outline_color = Color(1, 1, 1, 1) 🔗

void set_outline_color(value: Color)
Color get_outline_color()

轮廓的颜色。

int outline_size = 0 🔗

void set_outline_size(value: int)
int get_outline_size()

文本轮廓大小。

float paragraph_spacing = 0.0 🔗

void set_paragraph_spacing(value: float)
float get_paragraph_spacing()

段落之间的垂直空间。在 line_spacing 上添加。

Color shadow_color = Color(0, 0, 0, 0) 🔗

void set_shadow_color(value: Color)
Color get_shadow_color()

阴影效果的颜色。如果 Alpha 为 0 ，则不会绘制阴影。

Vector2 shadow_offset = Vector2(1, 1) 🔗

void set_shadow_offset(value: Vector2)
Vector2 get_shadow_offset()

阴影效果的偏移，单位为像素。

int shadow_size = 1 🔗

void set_shadow_size(value: int)
int get_shadow_size()

阴影效果的大小。

int stacked_outline_count = 0 🔗

void set_stacked_outline_count(value: int)
int get_stacked_outline_count()

堆叠轮廓的数量。

int stacked_shadow_count = 0 🔗

void set_stacked_shadow_count(value: int)
int get_stacked_shadow_count()

堆叠阴影的数量。

方法说明

void add_stacked_outline(index: int = -1) 🔗

为标签在索引为 index 处添加新的堆叠轮廓。如果 index 为 -1，则新的堆叠轮廓会添加到列表的末尾。

void add_stacked_shadow(index: int = -1) 🔗

为标签在索引为 index 处添加新的堆叠阴影。如果 index 为 -1，则新的堆叠阴影会添加到列表的末尾。

Color get_stacked_outline_color(index: int) const 🔗

返回索引为 index 的堆叠轮廓的颜色。

int get_stacked_outline_size(index: int) const 🔗

返回索引为 index 的堆叠轮廓的大小。

Color get_stacked_shadow_color(index: int) const 🔗

返回索引为 index 的堆叠阴影的颜色。

Vector2 get_stacked_shadow_offset(index: int) const 🔗

返回索引为 index 的堆叠阴影的偏移量。

int get_stacked_shadow_outline_size(index: int) const 🔗

返回索引为 index 的堆叠阴影的轮廓大小。

void move_stacked_outline(from_index: int, to_position: int) 🔗

将索引为 from_index 的堆叠轮廓移动至数组中的 to_position 位置。

void move_stacked_shadow(from_index: int, to_position: int) 🔗

将索引为 from_index 的堆叠阴影移动至数组中的 to_position 位置。

void remove_stacked_outline(index: int) 🔗

移除索引为 index 的堆叠轮廓。

void remove_stacked_shadow(index: int) 🔗

移除索引为 index 的堆叠阴影。

void set_stacked_outline_color(index: int, color: Color) 🔗

将索引为 index 的堆叠轮廓的颜色设为 color。

void set_stacked_outline_size(index: int, size: int) 🔗

将索引为 index 的堆叠轮廓的大小设为 size。

void set_stacked_shadow_color(index: int, color: Color) 🔗

将索引为 index 的堆叠阴影的颜色设为 color。

void set_stacked_shadow_offset(index: int, offset: Vector2) 🔗

将索引为 index 的堆叠阴影的偏移量设为 offset。

void set_stacked_shadow_outline_size(index: int, size: int) 🔗

将索引为 index 的堆叠阴影的轮廓大小设为 size。