TextParagraph

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

Утримуйте абзац тексту.

Опис

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

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

HorizontalAlignment	alignment	`0`
BitField[LineBreakFlag]	break_flags	`3`
String	custom_punctuation	`""`
Direction	direction	`0`
String	ellipsis_char	`"…"`
BitField[JustificationFlag]	justification_flags	`163`
float	line_spacing	`0.0`
int	max_lines_visible	`-1`
Orientation	orientation	`0`
bool	preserve_control	`false`
bool	preserve_invalid	`true`
OverrunBehavior	text_overrun_behavior	`0`
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	clear_dropcap()
void	draw(canvas: RID, pos: Vector2, color: Color = Color(1, 1, 1, 1), dc_color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
void	draw_dropcap(canvas: RID, pos: Vector2, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
void	draw_dropcap_outline(canvas: RID, pos: Vector2, outline_size: int = 1, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
void	draw_line(canvas: RID, pos: Vector2, line: int, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
void	draw_line_outline(canvas: RID, pos: Vector2, line: int, outline_size: int = 1, 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), dc_color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const
int	get_dropcap_lines() const
RID	get_dropcap_rid() const
Vector2	get_dropcap_size() const
Direction	get_inferred_direction() const
float	get_line_ascent(line: int) const
int	get_line_count() const
float	get_line_descent(line: int) const
Rect2	get_line_object_rect(line: int, key: Variant) const
Array	get_line_objects(line: int) const
Vector2i	get_line_range(line: int) const
RID	get_line_rid(line: int) const
Vector2	get_line_size(line: int) const
float	get_line_underline_position(line: int) const
float	get_line_underline_thickness(line: int) const
float	get_line_width(line: int) const
Vector2	get_non_wrapped_size() const
Vector2i	get_range() const
RID	get_rid() const
Vector2	get_size() const
int	hit_test(coords: Vector2) const
bool	resize_object(key: Variant, size: Vector2, inline_align: InlineAlignment = 5, baseline: float = 0.0)
void	set_bidi_override(override: Array)
bool	set_dropcap(text: String, font: Font, font_size: int, dropcap_margins: Rect2 = Rect2(0, 0, 0, 0), language: String = "")
void	tab_align(tab_stops: PackedFloat32Array)

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

HorizontalAlignment alignment = 0 🔗

void set_alignment(value: HorizontalAlignment)
HorizontalAlignment get_alignment()

Параграф горизонтального вирівнювання.

BitField[LineBreakFlag] break_flags = 3 🔗

void set_break_flags(value: BitField[LineBreakFlag])
BitField[LineBreakFlag] get_break_flags()

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

String custom_punctuation = "" 🔗

void set_custom_punctuation(value: String)
String get_custom_punctuation()

Користувальницькі списки символів пунктуації, що використовуються для розбиття слів. Якщо встановити порожній рядок, використовувані за замовчуванням сервера.

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] justification_flags = 163 🔗

void set_justification_flags(value: BitField[JustificationFlag])
BitField[JustificationFlag] get_justification_flags()

Правила вирівнювання заповнення рядків.

float line_spacing = 0.0 🔗

void set_line_spacing(value: float)
float get_line_spacing()

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

int max_lines_visible = -1 🔗

void set_max_lines_visible(value: int)
int get_max_lines_visible()

Лімітує рядки тексту, що показано.

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 = 0 🔗

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 clear_dropcap() 🔗

Видаліть скидання.

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

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

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

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

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

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

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

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

void draw_line_outline(canvas: RID, pos: Vector2, line: int, outline_size: int = 1, 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), dc_color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗

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

int get_dropcap_lines() const 🔗

Повертаємо кількість ліній, що використовуються крапельником.

RID get_dropcap_rid() const 🔗

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

Vector2 get_dropcap_size() const 🔗

Повернення випадаючою кришкою розмір коробки.

Direction get_inferred_direction() const 🔗

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

float get_line_ascent(line: int) const 🔗

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

int get_line_count() const 🔗

Повертає кількість рядків у пункті.

float get_line_descent(line: int) const 🔗

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

Rect2 get_line_object_rect(line: int, key: Variant) const 🔗

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

Array get_line_objects(line: int) const 🔗

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

Vector2i get_line_range(line: int) const 🔗

Повертає діапазон символів лінії.

RID get_line_rid(line: int) const 🔗

Повертає текстовий сервер лінійний буфер RID.

Vector2 get_line_size(line: int) const 🔗

Повертає розмір лімітованої коробки тексту. Повернути розмір закруглено.

float get_line_underline_position(line: int) const 🔗

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

float get_line_underline_thickness(line: int) const 🔗

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

float get_line_width(line: int) const 🔗

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

Vector2 get_non_wrapped_size() const 🔗

Повертає розмір межі абзацу, без розривів лінії.

Vector2i get_range() const 🔗

Повертає діапазон символів абзацу.

RID get_rid() const 🔗

Повертає TextServer повний буфер RID.

Vector2 get_size() const 🔗

Повертає розмір межі абзацу.

int hit_test(coords: Vector2) const 🔗

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

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

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

void set_bidi_override(override: Array) 🔗

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

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

bool set_dropcap(text: String, font: Font, font_size: int, dropcap_margins: Rect2 = Rect2(0, 0, 0, 0), language: String = "") 🔗

Набори крапельної ковпачки, надійшла попередньо встановлена кришка крапель. Краплий кришк (збитий капітал) - це декоративний елемент на початку абзацу, який більше, ніж решта тексту.

void tab_align(tab_stops: PackedFloat32Array) 🔗

Вирівнює абзацу до даної вкладки-стопок.