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

LabelSettings

Наследует: Resource < RefCounted < Object

Предоставляет общие настройки для настройки текста в 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
Color	stacked_outline_{index}/color	Color(0, 0, 0, 1)
int	stacked_outline_{index}/size	0
int	stacked_shadow_count	0
Color	stacked_shadow_{index}/color	Color(0, 0, 0, 1)
Vector2	stacked_shadow_{index}/offset	Vector2(1, 1)
int	stacked_shadow_{index}/outline_size	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()

Цвет эффекта тени. Если альфа равен 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()

Количество сложенных контуров.

---

Color stacked_outline_{index}/color = Color(0, 0, 0, 1) 🔗

Цвет контура по адресу index.

Примечание: index — это значение в диапазоне 0 .. stacked_outline_count - 1.

---

int stacked_outline_{index}/size = 0 🔗

Размер контура по адресу index.

Примечание: index — это значение в диапазоне 0 .. stacked_outline_count - 1.

---

int stacked_shadow_count = 0 🔗

• void set_stacked_shadow_count(value: int)

• int get_stacked_shadow_count()

Количество наложенных друг на друга теней.

---

Color stacked_shadow_{index}/color = Color(0, 0, 0, 1) 🔗

Цвет тени по адресу index.

Примечание: index — это значение в диапазоне 0 .. stacked_shadow_count - 1.

---

Vector2 stacked_shadow_{index}/offset = Vector2(1, 1) 🔗

Смещение тени по index.

Примечание: index — это значение в диапазоне от 0 .. stacked_shadow_count - 1.

---

int stacked_shadow_{index}/outline_size = 0 🔗

Размер контура тени по адресу index.

Примечание: index — это значение в диапазоне 0 .. stacked_shadow_count - 1.

---

Описания метода

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.