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

TextParagraph

Eredita: RefCounted < Object

Contiene un paragrafo di testo.

Descrizione

Astrazione sul TextServer per la gestione di un singolo paragrafo di testo.

Proprietà

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`

Metodi

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
TextParagraph	duplicate() 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
bool	has_object(key: Variant) 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)

Descrizioni delle proprietà

HorizontalAlignment alignment = 0 🔗

void set_alignment(value: HorizontalAlignment)
HorizontalAlignment get_alignment()

Allineamento orizzontale del paragrafo.

BitField[LineBreakFlag] break_flags = 3 🔗

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

Regole di interruzione di riga. Per ulteriori informazioni, vedi TextServer.

String custom_punctuation = "" 🔗

void set_custom_punctuation(value: String)
String get_custom_punctuation()

Lista personalizzata di caratteri di punteggiatura, utilizzati per suddividere le parole. Se impostato su stringa vuota, sono utilizzati i valori predefiniti del server.

Direction direction = 0 🔗

void set_direction(value: Direction)
Direction get_direction()

Direzione di scrittura del testo.

String ellipsis_char = "…" 🔗

void set_ellipsis_char(value: String)
String get_ellipsis_char()

Carattere di ellissi (puntini di sospensione) utilizzato per ritagliare il testo.

BitField[JustificationFlag] justification_flags = 163 🔗

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

Regole di allineamento del riempimento per le righe.

float line_spacing = 0.0 🔗

void set_line_spacing(value: float)
float get_line_spacing()

Spaziatura verticale aggiuntiva tra le righe (in pixel), la spaziatura è aggiunta alla discesa della riga. Questo valore può essere negativo.

int max_lines_visible = -1 🔗

void set_max_lines_visible(value: int)
int get_max_lines_visible()

Limita le righe del testo mostrato.

Orientation orientation = 0 🔗

void set_orientation(value: Orientation)
Orientation get_orientation()

Orientamento del testo.

bool preserve_control = false 🔗

void set_preserve_control(value: bool)
bool get_preserve_control()

Se impostato su true il testo visualizzerà i caratteri di controllo.

bool preserve_invalid = true 🔗

void set_preserve_invalid(value: bool)
bool get_preserve_invalid()

Se impostato sul true il testo visualizzerà i caratteri non validi.

OverrunBehavior text_overrun_behavior = 0 🔗

void set_text_overrun_behavior(value: OverrunBehavior)
OverrunBehavior get_text_overrun_behavior()

Il comportamento di ritaglio quando il testo supera la larghezza impostata del paragrafo.

float width = -1.0 🔗

void set_width(value: float)
float get_width()

Larghezza del paragrafo.

Descrizioni dei metodi

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

Aggiunge un oggetto in riga al buffer di testo, la chiave key deve essere univoca. Nel testo, l'oggetto è rappresentato come un numero di length caratteri di sostituzione.

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

Aggiunge una riga di testo e il font per disegnarla.

void clear() 🔗

Cancella il paragrafo di testo (rimuove il testo e gli oggetti in riga).

void clear_dropcap() 🔗

Rimuove il capolettera.

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 🔗

Disegna tutte le righe del testo e il capolettera in un elemento canvas in una posizione specificata, con il colore color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

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

Disegna il capolettera in un elemento canvas in una posizione specificata, con il colore color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

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

Disegna il contorno del capolettera in un elemento canvas in una posizione specificata, con il colore color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

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

Disegna una singola riga in un elemento canvas in una posizione specificata, con il colore color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

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 🔗

Disegna il contorno di una singola riga in un elemento canvas in una posizione specificata, con il colore color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

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 🔗

Disegna i contorni di tutte le righe del testo e del capolettera in un elemento canvas in una posizione specificata, con color. pos specifica l'angolo superiore sinistro del riquadro di delimitazione. Se oversampling è maggiore di zero, è utilizzato come fattore di sovracampionamento del font, altrimenti sono utilizzate le impostazioni di sovracampionamento della viewport.

TextParagraph duplicate() const 🔗

Duplicates this TextParagraph.

int get_dropcap_lines() const 🔗

Restituisce il numero di righe utilizzate dal capo lettera.

RID get_dropcap_rid() const 🔗

Restituisce il RID del buffer di testo del capolettera.

Vector2 get_dropcap_size() const 🔗

Restituisce il riquadro di delimitazione del capolettera.

Direction get_inferred_direction() const 🔗

Restituisce la direzione di scrittura del testo, dedotta dall'algoritmo BiDi.

float get_line_ascent(line: int) const 🔗

Restituisce l'ascesa della riga di testo (numero di pixel sopra la linea di base per un layout orizzontale o a sinistra della linea di base per un layout verticale).

int get_line_count() const 🔗

Restituisce il numero di righe nel paragrafo.

float get_line_descent(line: int) const 🔗

Restituisce la discesa della riga di testo (numero di pixel sotto la linea di base per un layout orizzontale o a destra della linea di base per un layout verticale).

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

Restituisce il rettangolo di delimitazione dell'oggetto in riga.

Array get_line_objects(line: int) const 🔗

Restituisce un'array di oggetti in riga nella riga.

Vector2i get_line_range(line: int) const 🔗

Restituisce la gamma di caratteri della riga.

RID get_line_rid(line: int) const 🔗

Restituisce il RID del buffer di riga nel TextServer.

Vector2 get_line_size(line: int) const 🔗

Restituisce le dimensioni del riquadro della riga di testo. Le dimensioni restituite sono arrotondate per eccesso.

float get_line_underline_position(line: int) const 🔗

Restituisce l'offset in pixel della sottolineatura sotto la linea di base.

float get_line_underline_thickness(line: int) const 🔗

Restituisce lo spessore della sottolineatura.

float get_line_width(line: int) const 🔗

Restituisce la larghezza (per il layout orizzontale) o l'altezza (per il layout verticale) della riga di testo.

Vector2 get_non_wrapped_size() const 🔗

Restituisce le dimensioni del riquadro del paragrafo, senza interruzioni di riga.

Vector2i get_range() const 🔗

Restituisce l'intervallo di caratteri del paragrafo.

RID get_rid() const 🔗

Restituisce il RID del buffer della stringa completa nel TextServer.

Vector2 get_size() const 🔗

Restituisce le dimensioni del riquadro del paragrafo.

bool has_object(key: Variant) const 🔗

Returns true if an object with key is embedded in this shaped text buffer.

int hit_test(coords: Vector2) const 🔗

Restituisce l'offset per il cursore alle coordinate specificate. Questa funzione restituisce sempre una posizione valida.

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

Imposta le nuove dimensioni e l'allineamento di un oggetto incorporato.

void set_bidi_override(override: Array) 🔗

Sostituisce il BiDi per il testo strutturato.

Gli intervalli di sostituzione devono coprire l'intero testo sorgente senza sovrapposizioni. L'algoritmo BiDi sarà utilizzato separatamente su ogni intervallo.

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

Imposta il capolettera, sovrascrive il capolettera impostato in precedenza. Il capolettera è un elemento decorativo all'inizio di un paragrafo che è più grande del resto del testo.

void tab_align(tab_stops: PackedFloat32Array) 🔗

Allinea il paragrafo alle tabulazioni specificate.