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.

TextLine

Eredita: RefCounted < Object

Mantiene una riga di testo.

Descrizione

Astrazione sul TextServer per la gestione di una singola riga di testo.

Proprietà

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

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

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

TextLine

duplicate() 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

bool

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


Descrizioni delle proprietà

HorizontalAlignment alignment = 0 🔗

Imposta l'allineamento del testo all'interno della riga come se la riga fosse orizzontale.


Direction direction = 0 🔗

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] flags = 3 🔗

Regole di allineamento delle righe. Per maggiori informazioni, vedi TextServer.


Orientation orientation = 0 🔗

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

Il comportamento di ritaglio quando il testo supera la larghezza impostata della riga di testo.


float width = -1.0 🔗

Larghezza della riga di testo.


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 la riga di testo (rimuove il testo e gli oggetti in riga).


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

Disegna il testo 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), oversampling: float = 0.0) const 🔗

Disegna il testo 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.


TextLine duplicate() const 🔗

Duplicates this TextLine.


Direction get_inferred_direction() const 🔗

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


float get_line_ascent() const 🔗

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


float get_line_descent() const 🔗

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


float get_line_underline_position() const 🔗

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


float get_line_underline_thickness() const 🔗

Restituisce lo spessore della sottolineatura.


float get_line_width() const 🔗

Restituisce la larghezza (per un layout orizzontale) o l'altezza (per un layout verticale) del testo.


Rect2 get_object_rect(key: Variant) const 🔗

Restituisce il rettangolo di delimitazione dell'oggetto in riga.


Array get_objects() const 🔗

Restituisce un array di oggetti in riga.


RID get_rid() const 🔗

Restituisce il RID del buffer nel TextServer.


Vector2 get_size() const 🔗

Restituisce le dimensioni del riquadro del testo.


bool has_object(key: Variant) const 🔗

Returns true if an object with key is embedded in this line.


int hit_test(coords: float) const 🔗

Restituisce l'offset per il cursore nel pixel specificato sulla linea di base. 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.


void tab_align(tab_stops: PackedFloat32Array) 🔗

Allinea il testo alle tabulazioni specificate.