TextLine

Успадковує: RefCounted < Object

Підтримує рядок тексту.

Опис

Анотація над TextServer для обробки одного рядка тексту.

Властивості

HorizontalAlignment	alignment	`0`
Direction	direction	`0`
String	ellipsis_char	`"…"`
BitField[JustificationFlag]	flags	`3`
Orientation	orientation	`0`
bool	preserve_control	`false`
bool	preserve_invalid	`true`
OverrunBehavior	text_overrun_behavior	`3`
float	width	`-1.0`

Методи

bool	add_object(key: Variant, size: Vector2, inline_align: InlineAlignment = 5, length: int = 1, baseline: float = 0.0)
bool	add_string(text: String, font: Font, font_size: int, language: String = "", meta: Variant = null)
void	clear()
void	draw(canvas: RID, pos: Vector2, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
void	draw_outline(canvas: RID, pos: Vector2, outline_size: int = 1, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
Direction	get_inferred_direction() const
float	get_line_ascent() const
float	get_line_descent() const
float	get_line_underline_position() const
float	get_line_underline_thickness() const
float	get_line_width() const
Rect2	get_object_rect(key: Variant) const
Array	get_objects() const
RID	get_rid() const
Vector2	get_size() const
int	hit_test(coords: float) const
bool	resize_object(key: Variant, size: Vector2, inline_align: InlineAlignment = 5, baseline: float = 0.0)
void	set_bidi_override(override: Array)
void	tab_align(tab_stops: PackedFloat32Array)

Описи властивостей

HorizontalAlignment alignment = 0 🔗

void set_horizontal_alignment(value: HorizontalAlignment)
HorizontalAlignment get_horizontal_alignment()

Встановлює вирівнювання тексту в рядку, якщо лінія була горизонтальною.

Direction direction = 0 🔗

void set_direction(value: Direction)
Direction get_direction()

Напрямок написання тексту.

String ellipsis_char = "…" 🔗

void set_ellipsis_char(value: String)
String get_ellipsis_char()

Елліпсис характер використовується для текстового затиску.

BitField[JustificationFlag] flags = 3 🔗

void set_flags(value: BitField[JustificationFlag])
BitField[JustificationFlag] get_flags()

Правила вирівнювання лінії. Для отримання додаткової інформації див. TextServer.

Orientation orientation = 0 🔗

void set_orientation(value: Orientation)
Orientation get_orientation()

Текстова спрямованість.

bool preserve_control = false 🔗

void set_preserve_control(value: bool)
bool get_preserve_control()

Якщо встановити на true текст буде відображати символи керування.

bool preserve_invalid = true 🔗

void set_preserve_invalid(value: bool)
bool get_preserve_invalid()

Якщо встановити на true текст буде відображатися недійсними символи.

OverrunBehavior text_overrun_behavior = 3 🔗

void set_text_overrun_behavior(value: OverrunBehavior)
OverrunBehavior get_text_overrun_behavior()

Поведінка обрізання, коли текст перевищує встановлену ширину рядка тексту.

float width = -1.0 🔗

void set_width(value: float)
float get_width()

Ширина лінії тексту.

Описи методів

bool add_object(key: Variant, size: Vector2, inline_align: InlineAlignment = 5, length: int = 1, baseline: float = 0.0) 🔗

Додає вбудований об'єкт до текстового буфера, key повинен бути унікальним. У тексті об'єкт представлений як символ заміни об'єкта length.

bool add_string(text: String, font: Font, font_size: int, language: String = "", meta: Variant = null) 🔗

Додає текстовий проміжок і шрифт, щоб його намалювати.

void clear() 🔗

Очищає текстову лінію (подає текст та інлайн об’єкти).

void draw(canvas: RID, pos: Vector2, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗

Намалюйте текст на елементі полотна у заданій позиції за допомогою параметра color. Параметр pos визначає верхній лівий кут рамки розміру. Якщо параметр oversampling більше за нуль, він використовується як коефіцієнт передискретизації шрифту, інакше використовуються налаштування передискретизації області перегляду.

void draw_outline(canvas: RID, pos: Vector2, outline_size: int = 1, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗

Намалюйте текст на елементі полотна у заданій позиції за допомогою параметра color. Параметр pos визначає верхній лівий кут рамки розміру. Якщо параметр oversampling більше за нуль, він використовується як коефіцієнт передискретизації шрифту, інакше використовуються налаштування передискретизації області перегляду.

Direction get_inferred_direction() const 🔗

Повертає напрямок написання тексту, визначений алгоритмом BiDi.

float get_line_ascent() const 🔗

Повернення текстового сходження (номер пікселів над базовою основою для горизонтального планування або зліва від базової лінії для вертикальної).

float get_line_descent() const 🔗

Повертає текстовий спуск (номер пікселів нижче базової лінії для горизонтального планування або праворуч від базової лінії для вертикальної).

float get_line_underline_position() const 🔗

Повертає піксельний зсув нижньої лінії нижче базової лінії.

float get_line_underline_thickness() const 🔗

Повертає товщину нижньої лінії.

float get_line_width() const 🔗

Повертає ширину (для горизонтального планування) або висоти (для вертикального) тексту.

Rect2 get_object_rect(key: Variant) const 🔗

Повертає межу прямокутника об'єкта inline.

Array get_objects() const 🔗

Повертає масив вбудованих об'єктів.

RID get_rid() const 🔗

Повернення текстового сервера буфера RID.

Vector2 get_size() const 🔗

Повертає розмір межі тексту.

int hit_test(coords: float) const 🔗

Повертає увагу, що вихід символів у зазначеному офсеті пікселя на базовій лінії. Ця функція завжди повертає дійсну позицію.

bool resize_object(key: Variant, size: Vector2, inline_align: InlineAlignment = 5, baseline: float = 0.0) 🔗

Налаштовує новий розмір і вирівнювання вбудованого об'єкта.

void set_bidi_override(override: Array) 🔗

Надійшла BiDi для структурованого тексту.

Визначні діапазони повинні закривати текст повного джерела без перекриття. Для кожного діапазону використовуйте алгоритм BiDi.

void tab_align(tab_stops: PackedFloat32Array) 🔗

Вирівнює текст на задану вкладку.