CharFXTransform

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

Управляет тем, как будет отображаться отдельный символ в RichTextEffect.

Описание

Задавая различные свойства этого объекта, вы можете управлять тем, как будут отображаться отдельные символы в RichTextEffect.

Обучающие материалы

BBCode в RichTextLabel

Свойства

Color	color	`Color(0, 0, 0, 1)`
float	elapsed_time	`0.0`
Dictionary	env	`{}`
RID	font	`RID()`
int	glyph_count	`0`
int	glyph_flags	`0`
int	glyph_index	`0`
Vector2	offset	`Vector2(0, 0)`
bool	outline	`false`
Vector2i	range	`Vector2i(0, 0)`
int	relative_index	`0`
Transform2D	transform	`Transform2D(1, 0, 0, 1, 0, 0)`
bool	visible	`true`

Описания свойств

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

void set_color(value: Color)
Color get_color()

Цвет, которым будет нарисован персонаж.

float elapsed_time = 0.0 🔗

void set_elapsed_time(value: float)
float get_elapsed_time()

Время, прошедшее с момента добавления RichTextLabel в дерево сцены (в секундах). Время останавливается, когда RichTextLabel приостанавливается (см. Node.process_mode). Сбрасывается, когда текст в RichTextLabel изменяется.

Примечание: Время все еще идет, пока RichTextLabel скрыт.

Dictionary env = {} 🔗

void set_environment(value: Dictionary)
Dictionary get_environment()

Содержит аргументы, переданные в открывающем теге BBCode. По умолчанию аргументы являются строками; если их содержимое соответствует типу, например bool, int или float, они будут преобразованы автоматически. Цветовые коды в форме #rrggbb или #rgb будут преобразованы в непрозрачный Color. Строковые аргументы не могут содержать пробелы, даже если они заключены в кавычки.

Если они присутствуют, кавычки также будут присутствовать в конечной строке. Например, открывающий тег BBCode [example foo=hello bar=true baz=42 color=#ffffff] будет сопоставлен со следующим Dictionary:

{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}

RID font = RID() 🔗

void set_font(value: RID)
RID get_font()

TextServer RID шрифта, используемого для отображения глифа, это значение можно использовать с методами TextServer.font_* для получения информации о шрифте.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

int glyph_count = 0 🔗

void set_glyph_count(value: int)
int get_glyph_count()

Количество глифов в кластере графем. Это значение задается в первом глифе кластера.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

int glyph_flags = 0 🔗

void set_glyph_flags(value: int)
int get_glyph_flags()

Флаги глифов. См. GraphemeFlag для получения дополнительной информации.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

int glyph_index = 0 🔗

void set_glyph_index(value: int)
int get_glyph_index()

Индекс глифа, специфичный для font. Если вы хотите заменить этот глиф, используйте TextServer.font_get_glyph_index() с font, чтобы получить новый индекс глифа для одного символа.

Vector2 offset = Vector2(0, 0) 🔗

void set_offset(value: Vector2)
Vector2 get_offset()

Смещение позиции, с которой будет нарисован символ (в пикселях).

bool outline = false 🔗

void set_outline(value: bool)
bool is_outline()

Если true, FX-преобразование вызывается для контурного рисования.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

Vector2i range = Vector2i(0, 0) 🔗

void set_range(value: Vector2i)
Vector2i get_range()

Абсолютный диапазон символов в строке, соответствующий глифу.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

int relative_index = 0 🔗

void set_relative_index(value: int)
int get_relative_index()

Смещение символа глифа относительно текущего пользовательского блока RichTextEffect.

Примечание: Только для чтения. Установка этого свойства не повлияет на рисование.

Transform2D transform = Transform2D(1, 0, 0, 1, 0, 0) 🔗

void set_transform(value: Transform2D)
Transform2D get_transform()

Текущее преобразование текущего глифа. Его можно переопределить (например, управляя положением и вращением из кривой). Вы также можете изменить существующее значение, чтобы применить преобразования поверх других эффектов.

bool visible = true 🔗

void set_visibility(value: bool)
bool is_visible()

Если true, символ будет нарисован. Если false, символ будет скрыт. Символы вокруг скрытых символов будут переформатированы, чтобы занять пространство скрытых символов. Если это нежелательно, вместо этого установите их color на Color(1, 1, 1, 0).