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...
TextServer
Hereda: RefCounted < Object
Heredado por: TextServerExtension
Una interfaz de servidor para la gestión de fuentes y el renderizado de texto.
Descripción
TextServer es el backend de la API para gestionar fuentes y renderizar texto.
Nota: Esta es una API de bajo nivel, considera usar las clases TextLine, TextParagraph y Font en su lugar.
Esta es una clase abstracta, así que para obtener la instancia de TextServer actualmente activa, usa el siguiente código:
var ts = TextServerManager.get_primary_interface()
var ts = TextServerManager.GetPrimaryInterface();
Métodos
Enumeraciones
enum FontAntialiasing: 🔗
FontAntialiasing FONT_ANTIALIASING_NONE = 0
Los glifos de fuentes se rasterizan como mapas de bits de 1 bit.
FontAntialiasing FONT_ANTIALIASING_GRAY = 1
Los glifos de las fuentes se rasterizan como mapas de bits con antialiasing en escala de grises de 8 bits.
FontAntialiasing FONT_ANTIALIASING_LCD = 2
Los glifos de la fuente se rasterizan para pantallas LCD.
La disposición de subpíxeles LCD se determina por el valor del ajuste ProjectSettings.gui/theme/lcd_subpixel_layout.
El modo de antialiasing de subpíxeles LCD solo es adecuado para renderizar texto horizontal sin escalar en 2D.
enum FontLCDSubpixelLayout: 🔗
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_NONE = 0
Disposición de subpíxeles desconocida o no soportada, el antialiasing de subpíxeles LCD está desactivado.
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_HRGB = 1
Disposición horizontal de subpíxeles RGB.
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_HBGR = 2
Disposición horizontal de subpíxeles BGR.
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_VRGB = 3
Disposición vertical de subpíxeles RGB.
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_VBGR = 4
Disposición de subpíxeles BGR vertical.
FontLCDSubpixelLayout FONT_LCD_SUBPIXEL_LAYOUT_MAX = 5
Representa el tamaño del enum FontLCDSubpixelLayout enum.
enum Direction: 🔗
Direction DIRECTION_AUTO = 0
La dirección del texto se determina en función del contenido y la configuración regional actual.
Direction DIRECTION_LTR = 1
El texto se escribe de izquierda a derecha.
Direction DIRECTION_RTL = 2
El texto se escribe de derecha a izquierda.
Direction DIRECTION_INHERITED = 3
La dirección de escritura del texto es la misma que la dirección de escritura de la string base. Se utiliza solo para la sobrescritura BiDi.
enum Orientation: 🔗
Orientation ORIENTATION_HORIZONTAL = 0
El texto está escrito horizontalmente.
Orientation ORIENTATION_VERTICAL = 1
El texto de izquierda a derecha se escribe verticalmente de arriba a abajo.
El texto de derecha a izquierda se escribe verticalmente de abajo a arriba.
flags JustificationFlag: 🔗
JustificationFlag JUSTIFICATION_NONE = 0
No justificar el texto.
JustificationFlag JUSTIFICATION_KASHIDA = 1
Justificar el texto añadiendo y eliminando kashidas.
JustificationFlag JUSTIFICATION_WORD_BOUND = 2
Justificar el texto cambiando el ancho de los espacios entre las palabras.
JustificationFlag JUSTIFICATION_TRIM_EDGE_SPACES = 4
Eliminar los espacios iniciales y finales del texto justificado.
JustificationFlag JUSTIFICATION_AFTER_LAST_TAB = 8
Aplicar justificación solo a la parte del texto después de la última tabulación.
JustificationFlag JUSTIFICATION_CONSTRAIN_ELLIPSIS = 16
Aplicar justificación a la línea recortada con puntos suspensivos.
JustificationFlag JUSTIFICATION_SKIP_LAST_LINE = 32
No aplicar justificación a la última línea del párrafo.
JustificationFlag JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 64
No aplicar justificación a la última línea del párrafo con caracteres visibles (tiene prioridad sobre JUSTIFICATION_SKIP_LAST_LINE).
JustificationFlag JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 128
Aplicar siempre la justificación a los párrafos con una sola línea (se ignoran JUSTIFICATION_SKIP_LAST_LINE y JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS).
enum AutowrapMode: 🔗
AutowrapMode AUTOWRAP_OFF = 0
El ajuste automático está desactivado.
AutowrapMode AUTOWRAP_ARBITRARY = 1
Ajusta el texto dentro del rectángulo delimitador del nodo permitiendo romper líneas en posiciones arbitrarias, lo que es útil cuando hay un espacio muy limitado disponible.
AutowrapMode AUTOWRAP_WORD = 2
Ajusta el texto dentro del rectángulo delimitador del nodo mediante saltos de línea suaves entre palabras.
AutowrapMode AUTOWRAP_WORD_SMART = 3
Se comporta de forma similar a AUTOWRAP_WORD, pero fuerza el salto de una palabra si esa única palabra no cabe en una línea.
flags LineBreakFlag: 🔗
LineBreakFlag BREAK_NONE = 0
No saltar de línea.
LineBreakFlag BREAK_MANDATORY = 1
Saltar de línea en los caracteres de salto de línea obligatorios (p. ej. "\n").
LineBreakFlag BREAK_WORD_BOUND = 2
Saltar de línea entre las palabras.
LineBreakFlag BREAK_GRAPHEME_BOUND = 4
Saltar de línea entre grafemas no conectados.
LineBreakFlag BREAK_ADAPTIVE = 8
Debe utilizarse solo junto con BREAK_WORD_BOUND, saltar de línea entre grafemas no conectados, si es imposible saltarla entre las palabras.
LineBreakFlag BREAK_TRIM_EDGE_SPACES = 16
Obsoleto: Use BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES instead.
Elimina los espacios al principio y al final de los segmentos de línea divididos.
LineBreakFlag BREAK_TRIM_INDENT = 32
Resta el ancho de sangría de la primera línea de todas las líneas después de la primera.
LineBreakFlag BREAK_TRIM_START_EDGE_SPACES = 64
Elimina los espacios y los caracteres de salto de línea del inicio de los segmentos de línea divididos.
Por ejemplo, después de dividir la línea, el segundo segmento del siguiente texto test \n next, es next si el flag está activado, y `` next`` si no lo está.
LineBreakFlag BREAK_TRIM_END_EDGE_SPACES = 128
Elimina los espacios y los caracteres de salto de línea del final de los segmentos de línea divididos.
Por ejemplo, después de dividir la línea, el primer segmento del siguiente texto test \n next, es test si el flag está activado, y test \n si no lo está.
enum VisibleCharactersBehavior: 🔗
VisibleCharactersBehavior VC_CHARS_BEFORE_SHAPING = 0
Recorta el texto antes de darle forma. Por ejemplo, aumentar el valor de Label.visible_characters o RichTextLabel.visible_characters es visualmente idéntico a escribir el texto.
Nota: En este modo, el texto recortado no se procesa en absoluto. No se tiene en cuenta en los cálculos de tamaño y salto de línea.
VisibleCharactersBehavior VC_CHARS_AFTER_SHAPING = 1
Muestra los glifos que están mapeados a los primeros Label.visible_characters o RichTextLabel.visible_characters caracteres desde el principio del texto.
VisibleCharactersBehavior VC_GLYPHS_AUTO = 2
Muestra glifos de Label.visible_ratio o RichTextLabel.visible_ratio, comenzando desde la izquierda o desde la derecha, dependiendo del valor de Control.layout_direction.
VisibleCharactersBehavior VC_GLYPHS_LTR = 3
Muestra glifos de Label.visible_ratio o RichTextLabel.visible_ratio, comenzando desde la izquierda.
VisibleCharactersBehavior VC_GLYPHS_RTL = 4
Muestra glifos de Label.visible_ratio o RichTextLabel.visible_ratio, comenzando desde la derecha.
enum OverrunBehavior: 🔗
OverrunBehavior OVERRUN_NO_TRIMMING = 0
No se realiza ningún recorte de texto.
OverrunBehavior OVERRUN_TRIM_CHAR = 1
Recorta el texto por carácter.
OverrunBehavior OVERRUN_TRIM_WORD = 2
Recorta el texto por palabra.
OverrunBehavior OVERRUN_TRIM_ELLIPSIS = 3
Recorta el texto por caracteres y añade puntos suspensivos para indicar que hay partes ocultas si el texto recortado tiene 6 caracteres o más.
OverrunBehavior OVERRUN_TRIM_WORD_ELLIPSIS = 4
Recorta el texto por palabras y añade puntos suspensivos para indicar que hay partes ocultas si el texto recortado tiene 6 caracteres o más.
OverrunBehavior OVERRUN_TRIM_ELLIPSIS_FORCE = 5
Recorta el texto por caracteres y añade puntos suspensivos para indicar que hay partes ocultas independientemente de la longitud del texto recortado.
OverrunBehavior OVERRUN_TRIM_WORD_ELLIPSIS_FORCE = 6
Recorta el texto por palabras y añade puntos suspensivos para indicar que hay partes ocultas independientemente de la longitud del texto recortado.
flags TextOverrunFlag: 🔗
TextOverrunFlag OVERRUN_NO_TRIM = 0
No se realiza ningún recorte.
TextOverrunFlag OVERRUN_TRIM = 1
Recorta el texto cuando excede el ancho dado.
TextOverrunFlag OVERRUN_TRIM_WORD_ONLY = 2
Recorta el texto por palabras en lugar de por grafemas.
TextOverrunFlag OVERRUN_ADD_ELLIPSIS = 4
Determina si se debe agregar una elipsis al final del texto.
TextOverrunFlag OVERRUN_ENFORCE_ELLIPSIS = 8
Determina si la elipsis al final del texto se aplica y no se puede ocultar.
TextOverrunFlag OVERRUN_JUSTIFICATION_AWARE = 16
Tiene en cuenta que el texto esté justificado antes de intentar recortarlo (véase JustificationFlag).
TextOverrunFlag OVERRUN_SHORT_STRING_ELLIPSIS = 32
Determina si los puntos suspensivos deben añadirse independientemente de la longitud de la string, de lo contrario solo se añaden si la string tiene 6 caracteres o más.
flags GraphemeFlag: 🔗
GraphemeFlag GRAPHEME_IS_VALID = 1
El grafema es compatible con la fuente y se puede dibujar.
GraphemeFlag GRAPHEME_IS_RTL = 2
El grafema es parte de un tramo de derecha a izquierda o de abajo a arriba.
GraphemeFlag GRAPHEME_IS_VIRTUAL = 4
El grafema no es parte del texto original, fue añadido por el proceso de justificación.
GraphemeFlag GRAPHEME_IS_SPACE = 8
El grafema es un espacio en blanco.
GraphemeFlag GRAPHEME_IS_BREAK_HARD = 16
El grafema es un punto de ruptura obligatorio (p. ej. "\n").
GraphemeFlag GRAPHEME_IS_BREAK_SOFT = 32
El grafema es un punto de ruptura opcional (p. ej. un espacio).
GraphemeFlag GRAPHEME_IS_TAB = 64
El grafema es el carácter de tabulación.
GraphemeFlag GRAPHEME_IS_ELONGATION = 128
El grafema es una kashida.
GraphemeFlag GRAPHEME_IS_PUNCTUATION = 256
El grafema es un carácter de puntuación.
GraphemeFlag GRAPHEME_IS_UNDERSCORE = 512
El grafema es un carácter de guion bajo.
GraphemeFlag GRAPHEME_IS_CONNECTED = 1024
El grafema está conectado al grafema anterior. No es seguro saltar de línea antes de este grafema.
GraphemeFlag GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 2048
Es seguro insertar un U+0640 antes de este grafema para su elongación.
GraphemeFlag GRAPHEME_IS_EMBEDDED_OBJECT = 4096
El grafema es un carácter de reemplazo de objeto para el objeto incrustado.
GraphemeFlag GRAPHEME_IS_SOFT_HYPHEN = 8192
El grafema es un guion suave.
enum Hinting: 🔗
Hinting HINTING_NONE = 0
Desactiva la indicación de la fuente (más suave pero menos nítida).
Hinting HINTING_LIGHT = 1
Usar el modo de indicación de la fuente de luz.
Hinting HINTING_NORMAL = 2
Usa el modo de hinting de la fuente por defecto (más nítido pero menos suave).
Nota: Este modo de hinting cambia las métricas horizontales y verticales de los glifos. Si se aplica a una fuente monoespaciada, algunos glifos pueden tener un ancho diferente.
enum SubpixelPositioning: 🔗
SubpixelPositioning SUBPIXEL_POSITIONING_DISABLED = 0
La posición horizontal del glifo se redondea al tamaño de un píxel entero, cada glifo se rasteriza una vez.
SubpixelPositioning SUBPIXEL_POSITIONING_AUTO = 1
La posición horizontal del glifo se redondea según el tamaño de la fuente.
A un cuarto del tamaño del píxel si el tamaño de la fuente es menor o igual a SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE.
A la mitad del tamaño del píxel si el tamaño de la fuente es menor o igual a SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE.
Al tamaño de píxel completo para fuentes más grandes.
SubpixelPositioning SUBPIXEL_POSITIONING_ONE_HALF = 2
La posición horizontal del glifo se redondea a la mitad del tamaño de un píxel, cada glifo se rasteriza hasta dos veces.
SubpixelPositioning SUBPIXEL_POSITIONING_ONE_QUARTER = 3
La posición horizontal del glifo se redondea a un cuarto del tamaño de un píxel, cada glifo se rasteriza hasta cuatro veces.
SubpixelPositioning SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20
Tamaño máximo de fuente que utilizará el posicionamiento de subpíxeles de "la mitad de un píxel" en el modo SUBPIXEL_POSITIONING_AUTO.
SubpixelPositioning SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16
Tamaño máximo de fuente que utilizará el posicionamiento de subpíxeles de "un cuarto de píxel" en el modo SUBPIXEL_POSITIONING_AUTO.
enum Feature: 🔗
Feature FEATURE_SIMPLE_LAYOUT = 1
El TextServer admite diseños de texto simples.
Feature FEATURE_BIDI_LAYOUT = 2
El TextServer admite diseños de texto bidireccionales.
Feature FEATURE_VERTICAL_LAYOUT = 4
El TextServer admite diseños verticales.
Feature FEATURE_SHAPING = 8
TextServer admite el modelado de texto complejo.
Feature FEATURE_KASHIDA_JUSTIFICATION = 16
El TextServer admite la justificación mediante kashidas.
Feature FEATURE_BREAK_ITERATORS = 32
El TextServer admite reglas complejas de salto de línea/palabra (p. ej., basadas en diccionarios).
Feature FEATURE_FONT_BITMAP = 64
El TextServer admite la carga de fuentes de mapa de bits.
Feature FEATURE_FONT_DYNAMIC = 128
El TextServer admite la carga de fuentes dinámicas (TrueType, OpenType, etc.).
Feature FEATURE_FONT_MSDF = 256
El TextServer admite el renderizado de fuentes dinámicas con campo de distancia con signo multicanal.
Feature FEATURE_FONT_SYSTEM = 512
El TextServer admite la carga de fuentes del sistema.
Feature FEATURE_FONT_VARIABLE = 1024
El TextServer admite fuentes variables.
Feature FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 2048
El TextServer admite la conversión de mayúsculas y minúsculas dependiente de la configuración regional y sensible al contexto.
Feature FEATURE_USE_SUPPORT_DATA = 4096
El TextServer requiere un archivo de datos externo para algunas características, ver load_support_data().
Feature FEATURE_UNICODE_IDENTIFIERS = 8192
El TextServer admite la validación de identificadores UAX #31, ver is_valid_identifier().
Feature FEATURE_UNICODE_SECURITY = 16384
El TextServer admite funciones de detección de spoofing basadas en el Informe Técnico de Unicode #36 y el Estándar Técnico de Unicode #39.
enum ContourPointTag: 🔗
ContourPointTag CONTOUR_CURVE_TAG_ON = 1
El punto de contorno está en la curva.
ContourPointTag CONTOUR_CURVE_TAG_OFF_CONIC = 0
El punto de contorno no está en la curva, pero sirve como punto de control para un arco de Bézier cónico (cuadrático).
ContourPointTag CONTOUR_CURVE_TAG_OFF_CUBIC = 2
El punto de contorno no está en la curva, pero sirve como punto de control para un arco de Bézier cúbico.
enum SpacingType: 🔗
SpacingType SPACING_GLYPH = 0
Espaciado para cada glifo.
SpacingType SPACING_SPACE = 1
Espaciado para el carácter de espacio.
SpacingType SPACING_TOP = 2
Espaciado en la parte superior de la línea.
SpacingType SPACING_BOTTOM = 3
Espaciado en la parte inferior de la línea.
SpacingType SPACING_MAX = 4
Representa el tamaño del enum SpacingType enum.
flags FontStyle: 🔗
FontStyle FONT_BOLD = 1
La fuente está en negrita.
FontStyle FONT_ITALIC = 2
La fuente está en cursiva u oblicua.
FontStyle FONT_FIXED_WIDTH = 4
La fuente tiene caracteres de ancho fijo (también conocida como monoespaciada).
enum StructuredTextParser: 🔗
StructuredTextParser STRUCTURED_TEXT_DEFAULT = 0
Utiliza el algoritmo Unicode BiDi predeterminado.
StructuredTextParser STRUCTURED_TEXT_URI = 1
Sobrescritura BiDi para URI.
StructuredTextParser STRUCTURED_TEXT_FILE = 2
Sobrescritura BiDi para la ruta del archivo.
StructuredTextParser STRUCTURED_TEXT_EMAIL = 3
Sobrescritura BiDi para el correo electrónico.
StructuredTextParser STRUCTURED_TEXT_LIST = 4
Sobrescritura BiDi para listas. Opciones de texto estructurado: separador de lista String.
StructuredTextParser STRUCTURED_TEXT_GDSCRIPT = 5
Sobrescritura BiDi para GDScript.
StructuredTextParser STRUCTURED_TEXT_CUSTOM = 6
Función de sobrescritura BiDi de texto estructurado definida por el usuario.
enum FixedSizeScaleMode: 🔗
FixedSizeScaleMode FIXED_SIZE_SCALE_DISABLE = 0
La fuente de mapa de bits no está escalada.
FixedSizeScaleMode FIXED_SIZE_SCALE_INTEGER_ONLY = 1
La fuente de mapa de bits se escala al múltiplo entero más cercano del tamaño fijo de la fuente. Esta es la opción recomendada para las fuentes pixel art.
FixedSizeScaleMode FIXED_SIZE_SCALE_ENABLED = 2
La fuente de mapa de bits se escala a un tamaño arbitrario (fraccionario). Esta es la opción recomendada para las fuentes que no son pixel art.
Descripciones de Métodos
Crea un nuevo recurso de entrada de caché de fuente vacío. Para liberar el recurso resultante, usa el método free_rid().
RID create_font_linked_variation(font_rid: RID) 🔗
Crea una nueva variación de fuente existente que reutiliza la misma caché de glifos y datos de fuente. Para liberar el recurso resultante, usa el método free_rid().
RID create_shaped_text(direction: Direction = 0, orientation: Orientation = 0) 🔗
Crea un nuevo búfer para la disposición de texto complejo, con la direction y orientation dadas. Para liberar el búfer resultante, usa el método free_rid().
Nota: La dirección se ignora si el servidor no soporta la característica FEATURE_BIDI_LAYOUT (soportada por TextServerAdvanced).
Nota: La orientación se ignora si el servidor no soporta la característica FEATURE_VERTICAL_LAYOUT (soportada por TextServerAdvanced).
void draw_hex_code_box(canvas: RID, size: int, pos: Vector2, index: int, color: Color) const 🔗
Dibuja una caja que muestra el código hexadecimal del carácter. Se usa para reemplazar caracteres perdidos.
void font_clear_glyphs(font_rid: RID, size: Vector2i) 🔗
Elimina toda la información de glifos renderizados de la entrada de la caché.
Nota: Esta función no eliminará las texturas asociadas con los glifos; usa el método font_remove_texture() para eliminarlas manualmente.
void font_clear_kerning_map(font_rid: RID, size: int) 🔗
Elimina todas las modificaciones de kerning.
void font_clear_size_cache(font_rid: RID) 🔗
Elimina todos los tamaños de fuente de la entrada de caché.
void font_clear_system_fallback_cache() 🔗
Libera todas las fuentes del sistema cargadas automáticamente.
void font_clear_textures(font_rid: RID, size: Vector2i) 🔗
Elimina todas las texturas de la entrada de la caché de fuentes.
Nota: Esta función no eliminará los glifos asociados con la textura; usa el método font_remove_glyph() para eliminarlos manualmente.
void font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗
Dibuja un solo glifo en un elemento canvas en la posición, usando font_rid al tamaño size. Si oversampling es mayor que cero, se usa como factor de sobremuestreo de la fuente; de lo contrario, se usan las configuraciones de sobremuestreo del viewport.
Nota: El índice del glifo es específico de la fuente; usa los índices de glifo devueltos por shaped_text_get_glyphs() o font_get_glyph_index().
Nota: Si hay glifos pendientes de renderizar, llamar a esta función podría activar la actualización de la caché de texturas.
void font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗
Dibuja el contorno de un solo glifo de tamaño outline_size en un elemento canvas en la posición, usando font_rid al tamaño size. Si oversampling es mayor que cero, se usa como factor de sobremuestreo de la fuente; de lo contrario, se usan las configuraciones de sobremuestreo del viewport.
Nota: El índice del glifo es específico de la fuente; usa los índices de glifo devueltos por shaped_text_get_glyphs() o font_get_glyph_index().
Nota: Si hay glifos pendientes de renderizar, llamar a esta función podría activar la actualización de la caché de texturas.
FontAntialiasing font_get_antialiasing(font_rid: RID) const 🔗
Devuelve el modo de anti-aliasing de fuentes.
float font_get_ascent(font_rid: RID, size: int) const 🔗
Devuelve el ascenso de la fuente (número de píxeles por encima de la línea de base).
float font_get_baseline_offset(font_rid: RID) const 🔗
Devuelve el desplazamiento adicional de la línea base (como una fracción de la altura de la fuente).
int font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) const 🔗
Devuelve el código de carácter asociado con glyph_index, o 0 si glyph_index no es válido. Véase font_get_glyph_index().
float font_get_descent(font_rid: RID, size: int) const 🔗
Devuelve el descenso de la fuente (número de píxeles por debajo de la línea de base).
bool font_get_disable_embedded_bitmaps(font_rid: RID) const 🔗
Devuelve si la carga de mapas de bits incrustados de la fuente está deshabilitada.
float font_get_embolden(font_rid: RID) const 🔗
Devuelve la intensidad del resaltado de la fuente.
int font_get_face_count(font_rid: RID) const 🔗
Devuelve el número de caras en la colección TrueType/OpenType.
int font_get_face_index(font_rid: RID) const 🔗
Devuelve un índice de cara activo en la colección TrueType/OpenType.
int font_get_fixed_size(font_rid: RID) const 🔗
Devuelve el tamaño fijo de la fuente de mapa de bits.
FixedSizeScaleMode font_get_fixed_size_scale_mode(font_rid: RID) const 🔗
Devuelve el modo de escalado de la fuente de mapa de bits.
bool font_get_generate_mipmaps(font_rid: RID) const 🔗
Devuelve true si la generación de mipmaps de la textura de la fuente está habilitada.
float font_get_global_oversampling() const 🔗
Obsoleto: Use Viewport oversampling, or the oversampling argument of the draw_* methods instead.
Este método no hace nada y siempre devuelve 1.0.
Vector2 font_get_glyph_advance(font_rid: RID, size: int, glyph: int) const 🔗
Devuelve el avance del glifo (desplazamiento del siguiente glifo).
Nota: El avance de los contornos de los glifos es el mismo que el avance del glifo base y no se guarda.
Dictionary font_get_glyph_contours(font: RID, size: int, index: int) const 🔗
Devuelve los contornos del glifo como un Dictionary con el siguiente contenido:
points - PackedVector3Array, que contiene los puntos del contorno. x e y son las coordenadas del punto. z es el tipo del punto, usando los valores de ContourPointTag.
contours - PackedInt32Array, que contiene los índices de los puntos finales de cada contorno.
orientation - bool, orientación del contorno. Si es true, los contornos en sentido horario deben rellenarse.
Dos puntos sucesivos CONTOUR_CURVE_TAG_ON indican un segmento de línea.
Un punto CONTOUR_CURVE_TAG_OFF_CONIC entre dos puntos CONTOUR_CURVE_TAG_ON indica un único arco Bézier cónico (cuadrático).
Dos puntos CONTOUR_CURVE_TAG_OFF_CUBIC entre dos puntos CONTOUR_CURVE_TAG_ON indican un único arco Bézier cúbico.
Dos puntos sucesivos CONTOUR_CURVE_TAG_OFF_CONIC indican dos arcos Bézier cónicos (cuadráticos) sucesivos con un punto CONTOUR_CURVE_TAG_ON virtual en su medio.
Cada contorno está cerrado. El último punto de un contorno utiliza el primer punto de un contorno como su siguiente punto, y viceversa. El primer punto puede ser un punto CONTOUR_CURVE_TAG_OFF_CONIC.
int font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) const 🔗
Devuelve el índice del glifo de un char, modificado opcionalmente por el variation_selector. Véase font_get_char_from_glyph_index().
PackedInt32Array font_get_glyph_list(font_rid: RID, size: Vector2i) const 🔗
Devuelve la lista de glifos representados en la entrada de caché.
Vector2 font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el desplazamiento del glifo desde la línea base.
Vector2 font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el tamaño del glifo.
int font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el índice de la textura de caché que contiene el glifo.
RID font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el ID del recurso de la textura caché que contiene el glifo.
Nota: Si hay glifos pendientes de renderizar, llamar a esta función podría activar la actualización de la caché de texturas.
Vector2 font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el tamaño de la textura caché que contiene el glifo.
Nota: Si hay glifos pendientes de renderizar, llamar a esta función podría activar la actualización de la caché de texturas.
Rect2 font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) const 🔗
Devuelve el rectángulo en la textura de caché que contiene el glifo.
Hinting font_get_hinting(font_rid: RID) const 🔗
Devuelve el modo de sugerencia de fuente. Solo se utiliza con fuentes dinámicas.
bool font_get_keep_rounding_remainders(font_rid: RID) const 🔗
Devuelve el comportamiento de redondeo de la posición del glifo. Si se establece en true, al alinear los glifos con los límites de los píxeles, los restos del redondeo se acumulan para asegurar una distribución más uniforme de los glifos. Este ajuste no tiene efecto si el posicionamiento subpíxel está habilitado.
Vector2 font_get_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) const 🔗
Devuelve el kerning para el par de glifos.
Array[Vector2i] font_get_kerning_list(font_rid: RID, size: int) const 🔗
Devuelve una lista de anulaciones de kerning.
bool font_get_language_support_override(font_rid: RID, language: String) 🔗
Devuelve true si la sobrescritura de soporte está habilitada para el language.
PackedStringArray font_get_language_support_overrides(font_rid: RID) 🔗
Devuelve una lista de anulaciones de soporte de idiomas.
int font_get_msdf_pixel_range(font_rid: RID) const 🔗
Devuelve el ancho del rango alrededor de la forma entre la distancia con signo mínima y máxima representable.
int font_get_msdf_size(font_rid: RID) const 🔗
Devuelve el tamaño de la fuente original utilizada para generar texturas MSDF.
String font_get_name(font_rid: RID) const 🔗
Devuelve el nombre de la familia de fuentes.
Dictionary font_get_opentype_feature_overrides(font_rid: RID) const 🔗
Devuelve la sobrescritura del conjunto de características de la fuente OpenType.
Dictionary font_get_ot_name_strings(font_rid: RID) const 🔗
Devuelve un Dictionary con cadenas de nombre de fuente OpenType (nombres de fuente localizados, versión, descripción, información de licencia, texto de ejemplo, etc.).
float font_get_oversampling(font_rid: RID) const 🔗
Devuelve la sobrescritura del factor de sobremuestreo. Si se establece en un valor positivo, sobrescribe el factor de sobremuestreo del viewport en el que se utiliza esta fuente. Véase Viewport.oversampling. Este valor no sobrescribe el parámetro oversampling de los métodos draw_*. Se utiliza solo en fuentes dinámicas.
PackedColorArray font_get_palette_colors(font_rid: RID, index: int) const 🔗
Returns the array in the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors. Colors can be overridden using font_set_palette_custom_colors().
int font_get_palette_count(font_rid: RID) const 🔗
Returns the number of predefined color palettes. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.
PackedColorArray font_get_palette_custom_colors(font_rid: RID) const 🔗
Returns array of custom colors to override predefined palette.
String font_get_palette_name(font_rid: RID, index: int) const 🔗
Returns the name of the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.
float font_get_scale(font_rid: RID, size: int) const 🔗
Devuelve el factor de escala de la fuente de mapa de bits de color.
bool font_get_script_support_override(font_rid: RID, script: String) 🔗
Devuelve true si la sobrescritura de soporte está habilitada para el script.
PackedStringArray font_get_script_support_overrides(font_rid: RID) 🔗
Devuelve una lista de anulaciones de compatibilidad de scripts.
Array[Dictionary] font_get_size_cache_info(font_rid: RID) const 🔗
Devuelve información sobre la caché de fuentes, cada entrada contiene los siguientes campos: Vector2i size_px - tamaño de la fuente en píxeles, float viewport_oversampling - factor de sobremuestreo del viewport, int glyphs - número de glifos renderizados, int textures - número de texturas utilizadas, int textures_size - tamaño de los datos de la textura en bytes.
Array[Vector2i] font_get_size_cache_list(font_rid: RID) const 🔗
Devuelve una lista de los tamaños de fuente en la caché. Cada tamaño es Vector2i con el tamaño de la fuente y el tamaño del contorno.
int font_get_spacing(font_rid: RID, spacing: SpacingType) const 🔗
Devuelve el espaciado para spacing en píxeles (no relativo al tamaño de la fuente).
int font_get_stretch(font_rid: RID) const 🔗
Devuelve el grado de estiramiento de la fuente, comparado con un ancho normal. Un valor porcentual entre 50% y 200%.
BitField[FontStyle] font_get_style(font_rid: RID) const 🔗
Devuelve las banderas de estilo de la fuente.
String font_get_style_name(font_rid: RID) const 🔗
Devuelve el nombre del estilo de la fuente.
SubpixelPositioning font_get_subpixel_positioning(font_rid: RID) const 🔗
Devuelve el modo de posicionamiento de glifo de subpíxeles de fuente.
String font_get_supported_chars(font_rid: RID) const 🔗
Devuelve una string que contiene todos los caracteres disponibles en la fuente.
PackedInt32Array font_get_supported_glyphs(font_rid: RID) const 🔗
Devuelve un array que contiene todos los índices de glifos en la fuente.
int font_get_texture_count(font_rid: RID, size: Vector2i) const 🔗
Devuelve el número de texturas utilizadas por la entrada de caché de fuentes.
Image font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) const 🔗
Devuelve datos de imagen de textura de caché de fuente.
PackedInt32Array font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) const 🔗
Devuelve un array que contiene los datos de empaquetado de glifos.
Transform2D font_get_transform(font_rid: RID) const 🔗
Devuelve la transformación 2D aplicada a los contornos de la fuente.
float font_get_underline_position(font_rid: RID, size: int) const 🔗
Devuelve el desplazamiento de píxeles del subrayado debajo de la línea base.
float font_get_underline_thickness(font_rid: RID, size: int) const 🔗
Devuelve el grosor del subrayado en píxeles.
int font_get_used_palette(font_rid: RID) const 🔗
Returns used palette index.
Dictionary font_get_variation_coordinates(font_rid: RID) const 🔗
Devuelve las coordenadas de variación para la entrada de caché de fuente especificada. Véase font_supported_variation_list() para más información.
int font_get_weight(font_rid: RID) const 🔗
Devuelve el peso (grosor) de la fuente. Un valor en el rango 100...999, el peso normal de la fuente es 400, el peso de la fuente en negrita es 700.
bool font_has_char(font_rid: RID, char: int) const 🔗
Devuelve true si un char Unicode está disponible en la fuente.
bool font_is_allow_system_fallback(font_rid: RID) const 🔗
Devuelve true si las fuentes del sistema pueden utilizarse automáticamente como alternativas.
bool font_is_force_autohinter(font_rid: RID) const 🔗
Devuelve true si el hinting automático es compatible y preferible al hinting incorporado en la fuente. Se utiliza solo en fuentes dinámicas.
bool font_is_language_supported(font_rid: RID, language: String) const 🔗
Returns true if the font supports the given language (as a ISO 639 code).
bool font_is_modulate_color_glyphs(font_rid: RID) const 🔗
Devuelve true si la modulación de color se aplica al dibujar los glifos coloreados de la fuente.
bool font_is_multichannel_signed_distance_field(font_rid: RID) const 🔗
Devuelve true si los glifos de todos los tamaños se renderizan utilizando un único campo de distancia firmado multicanal generado a partir de los datos vectoriales de la fuente dinámica.
bool font_is_script_supported(font_rid: RID, script: String) const 🔗
Returns true if the font supports the given script (as a ISO 15924 code).
void font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) 🔗
Elimina la información del glifo renderizado especificado de la entrada de caché.
Nota: Esta función no eliminará las texturas asociadas con los glifos, usa font_remove_texture() para eliminarlas manualmente.
void font_remove_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) 🔗
Elimina la sobrescritura de kerning para el par de glifos.
void font_remove_language_support_override(font_rid: RID, language: String) 🔗
Elimina la sobrescritura de soporte de idioma.
void font_remove_script_support_override(font_rid: RID, script: String) 🔗
Elimina la sobrescritura de soporte de script.
void font_remove_size_cache(font_rid: RID, size: Vector2i) 🔗
Elimina el tamaño de fuente especificado de la entrada de caché.
void font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) 🔗
Elimina la textura especificada de la entrada de caché.
Nota: Esta función no eliminará los glifos asociados con la textura, elimínalos manualmente, usando font_remove_glyph().
void font_render_glyph(font_rid: RID, size: Vector2i, index: int) 🔗
Renderiza el glifo especificado en la textura de caché de la fuente.
void font_render_range(font_rid: RID, size: Vector2i, start: int, end: int) 🔗
Representa el rango de caracteres en la textura de caché de fuentes.
void font_set_allow_system_fallback(font_rid: RID, allow_system_fallback: bool) 🔗
Si se establece en true, las fuentes del sistema se pueden utilizar automáticamente como alternativas.
void font_set_antialiasing(font_rid: RID, antialiasing: FontAntialiasing) 🔗
Establece el modo de antialiasing de la fuente.
void font_set_ascent(font_rid: RID, size: int, ascent: float) 🔗
Establece el ascenso de la fuente (número de píxeles por encima de la línea base).
void font_set_baseline_offset(font_rid: RID, baseline_offset: float) 🔗
Establece el desplazamiento extra de la línea de base (como una fracción de la altura de la fuente).
void font_set_data(font_rid: RID, data: PackedByteArray) 🔗
Establece los datos de origen de la fuente, por ejemplo, el contenido del archivo de origen de la fuente dinámica.
void font_set_descent(font_rid: RID, size: int, descent: float) 🔗
Establece el descenso de la fuente (número de píxeles por debajo de la línea de base).
void font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) 🔗
Si se establece en true, la carga de mapas de bits de fuentes incrustados se desactiva (las fuentes solo de mapa de bits y de color ignoran esta propiedad).
void font_set_embolden(font_rid: RID, strength: float) 🔗
Establece la fuerza de realce de la fuente. Si strength no es igual a cero, realza los contornos de la fuente. Los valores negativos reducen el grosor del contorno.
void font_set_face_index(font_rid: RID, face_index: int) 🔗
Establece un índice de cara activo en la colección TrueType/OpenType.
void font_set_fixed_size(font_rid: RID, fixed_size: int) 🔗
Establece el tamaño fijo de la fuente de mapa de bits. Si se establece en un valor mayor que cero, se utilizará la misma entrada de caché para todos los tamaños de fuente.
void font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) 🔗
Establece el modo de escalado de la fuente de mapa de bits. Esta propiedad sólo se utiliza si fixed_size es mayor que cero.
void font_set_force_autohinter(font_rid: RID, force_autohinter: bool) 🔗
Si se establece en true, se prefiere el hinting automático al hinting incorporado en la fuente.
void font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool) 🔗
Si se establece en true, la generación de mipmap de textura de fuente está habilitada.
void font_set_global_oversampling(oversampling: float) 🔗
Obsoleto: Use Viewport oversampling, or the oversampling argument of the draw_* methods instead.
Este método no hace nada.
void font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) 🔗
Establece el avance del glifo (desplazamiento del siguiente glifo).
Nota: El avance de los contornos de los glifos es el mismo que el avance del glifo base y no se guarda.
void font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) 🔗
Establece el desplazamiento del glifo desde la línea de base.
void font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) 🔗
Establece el tamaño del glifo.
void font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) 🔗
Establece el índice de la textura de caché que contiene el glifo.
void font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) 🔗
Establece el rectángulo en la textura de caché que contiene el glifo.
void font_set_hinting(font_rid: RID, hinting: Hinting) 🔗
Establece el modo de hinting de la fuente. Solo se usa en fuentes dinámicas.
void font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool) 🔗
Establece el comportamiento de redondeo de la posición del glifo. Si se establece en true, al alinear los glifos con los límites de los píxeles, los restos del redondeo se acumulan para asegurar una distribución más uniforme de los glifos. Este ajuste no tiene efecto si el posicionamiento por subpíxel está habilitado.
void font_set_kerning(font_rid: RID, size: int, glyph_pair: Vector2i, kerning: Vector2) 🔗
Establece el kerning para el par de glifos.
void font_set_language_support_override(font_rid: RID, language: String, supported: bool) 🔗
Añade una sobrescritura para font_is_language_supported().
void font_set_modulate_color_glyphs(font_rid: RID, modulate: bool) 🔗
Si se establece como true, la modulación de color se aplica al dibujar glifos coloreados, de lo contrario, se aplica solo a los glifos monocromáticos.
void font_set_msdf_pixel_range(font_rid: RID, msdf_pixel_range: int) 🔗
Establece el ancho del rango alrededor de la forma entre la distancia firmada mínima y máxima representable.
void font_set_msdf_size(font_rid: RID, msdf_size: int) 🔗
Establece el tamaño de la fuente de origen utilizada para generar texturas MSDF.
void font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool) 🔗
Si se establece en true, los glifos de todos los tamaños se renderizan utilizando un único campo de distancia con signo multicanal generado a partir de los datos vectoriales de la fuente dinámica. El renderizado MSDF permite mostrar la fuente a cualquier factor de escala sin que se vea borrosa y sin incurrir en un coste de CPU cuando cambia el tamaño de la fuente (ya que la fuente ya no necesita ser rasterizada en la CPU). Como desventaja, el hinting de fuentes no está disponible con MSDF. La falta de hinting de fuentes puede dar como resultado fuentes menos nítidas y menos legibles en tamaños pequeños.
Nota: El renderizado de fuentes MSDF no renderiza correctamente los glifos con formas superpuestas. Las formas superpuestas no son válidas según el estándar OpenType, pero aún se encuentran comúnmente en muchos archivos de fuentes, especialmente aquellos convertidos por Google Fonts. Para evitar problemas con los glifos superpuestos, considera descargar el archivo de fuente directamente de la fundición de tipos en lugar de confiar en Google Fonts.
void font_set_name(font_rid: RID, name: String) 🔗
Establece el nombre de la familia de fuentes.
void font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary) 🔗
Establece la sobrescritura del conjunto de características OpenType de la fuente.
void font_set_oversampling(font_rid: RID, oversampling: float) 🔗
Si se establece en un valor positivo, sobrescribe el factor de sobremuestreo del viewport en la que se utiliza esta fuente. Véase Viewport.oversampling. Este valor no sobrescribe el parámetro oversampling de los métodos draw_*. Se utiliza solo con fuentes dinámicas.
void font_set_palette_custom_colors(font_rid: RID, colors: PackedColorArray) 🔗
Sets array of custom colors to override predefined palette. Set to empty array to reset overrides. Use Color(0, 0, 0, 0), to keep predefined palette color at specific position.
void font_set_scale(font_rid: RID, size: int, scale: float) 🔗
Establece el factor de escala de la fuente de mapa de bits de color.
void font_set_script_support_override(font_rid: RID, script: String, supported: bool) 🔗
Añade una sobrescritura para font_is_script_supported().
void font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) 🔗
Establece el espaciado para spacing a value en píxeles (no en relación con el tamaño de la fuente).
void font_set_stretch(font_rid: RID, weight: int) 🔗
Establece la cantidad de estiramiento de la fuente, en comparación con un ancho normal. Un valor porcentual entre 50% y 200%.
Nota: Este valor se utiliza solo para la coincidencia de fuentes y no afectará a la representación de la fuente. Utiliza font_set_face_index(), font_set_variation_coordinates() o font_set_transform() en su lugar.
void font_set_style(font_rid: RID, style: BitField[FontStyle]) 🔗
Establece los flags de estilo de la fuente.
Nota: Este valor se utiliza solo para la coincidencia de fuentes y no afectará a la representación de la fuente. Utiliza font_set_face_index(), font_set_variation_coordinates(), font_set_embolden() o font_set_transform() en su lugar.
void font_set_style_name(font_rid: RID, name: String) 🔗
Establece el nombre del estilo de fuente.
void font_set_subpixel_positioning(font_rid: RID, subpixel_positioning: SubpixelPositioning) 🔗
Establece el modo de posicionamiento de glifos de subpíxeles de fuente.
void font_set_texture_image(font_rid: RID, size: Vector2i, texture_index: int, image: Image) 🔗
Establece los datos de la imagen de textura de caché de fuentes.
void font_set_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int, offset: PackedInt32Array) 🔗
Establece un array que contiene datos de empaquetado de glifos.
void font_set_transform(font_rid: RID, transform: Transform2D) 🔗
Establece la transformación 2D, aplicada a los contornos de la fuente, que puede utilizarse para inclinar, voltear y rotar glifos.
Por ejemplo, para simular un tipo de letra en cursiva inclinando, aplica la siguiente transformación Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0).
void font_set_underline_position(font_rid: RID, size: int, underline_position: float) 🔗
Establece el desplazamiento en píxeles del subrayado por debajo de la línea de base.
void font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) 🔗
Establece el grosor del subrayado en píxeles.
void font_set_used_palette(font_rid: RID, index: int) 🔗
Sets used palette index.
void font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) 🔗
Establece las coordenadas de variación para la entrada de caché de fuente especificada. Véase font_supported_variation_list() para más información.
void font_set_weight(font_rid: RID, weight: int) 🔗
Establece el peso (grosor) de la fuente. Un valor en el rango 100...999, el peso normal de la fuente es 400, el peso de la fuente en negrita es 700.
Nota: Este valor se utiliza solo para la coincidencia de fuentes y no afectará a la representación de la fuente. Utiliza font_set_face_index(), font_set_variation_coordinates() o font_set_embolden() en su lugar.
Dictionary font_supported_feature_list(font_rid: RID) const 🔗
Devuelve el diccionario de las características OpenType admitidas.
Dictionary font_supported_variation_list(font_rid: RID) const 🔗
Devuelve el diccionario de las coordenadas de variación OpenType admitidas.
String format_number(number: String, language: String = "") const 🔗
Obsoleto: Use TranslationServer.format_number() instead.
Convierte un número del sistema arábigo occidental (0..9) al sistema numérico utilizado en el language dado.
Si language es una string vacía, se utilizará la configuración regional activa.
Libera un objeto creado por este TextServer.
Devuelve las características del servidor de texto, véase Feature.
Vector2 get_hex_code_box_size(size: int, index: int) const 🔗
Devuelve el tamaño del carácter de reemplazo (cuadro con el código hexadecimal del carácter que se dibuja en lugar de los caracteres no válidos).
Devuelve el nombre de la interfaz del servidor.
PackedByteArray get_support_data() const 🔗
Devuelve la base de datos predeterminada de TextServer (por ejemplo, iteradores de corte y diccionarios de ICU).
String get_support_data_filename() const 🔗
Devuelve el nombre de archivo de la base de datos predeterminada de TextServer (por ejemplo, iteradores de corte y diccionarios de ICU).
String get_support_data_info() const 🔗
Devuelve la descripción de la base de datos de TextServer (por ejemplo, iteradores de corte y diccionarios de ICU).
Devuelve true si rid es un recurso válido y propiedad de este servidor de texto.
bool has_feature(feature: Feature) const 🔗
Devuelve true si el servidor soporta una característica.
int is_confusable(string: String, dict: PackedStringArray) const 🔗
Devuelve el índice de la primera string en dict que es visualmente confusa con la string, o -1 si no se encuentra ninguna.
Nota: Este método no detecta caracteres invisibles, para la detección de spoof, utilícelo en combinación con spoof_check().
Nota: Siempre devuelve -1 si el servidor no es compatible con la característica FEATURE_UNICODE_SECURITY.
bool is_locale_right_to_left(locale: String) const 🔗
Devuelve true si la configuración regional es de derecha a izquierda.
bool is_locale_using_support_data(locale: String) const 🔗
Devuelve true si la configuración regional requiere datos de soporte del servidor de texto para el salto de línea/palabra.
bool is_valid_identifier(string: String) const 🔗
Devuelve true si string es un identificador válido.
Si el servidor de texto soporta la característica FEATURE_UNICODE_IDENTIFIERS, un identificador válido debe:
Cumplir con la forma de normalización C.
Comenzar con un carácter Unicode de la clase XID_Start o
"_".Puede contener caracteres Unicode de la clase XID_Continue en las otras posiciones.
Utilizar solo scripts recomendados por UAX #31 (se permiten scripts mixtos).
Si la característica FEATURE_UNICODE_IDENTIFIERS no es soportada, un identificador válido debe:
Comenzar con un carácter Unicode de la clase XID_Start o
"_".Puede contener caracteres Unicode de la clase XID_Continue en las otras posiciones.
bool is_valid_letter(unicode: int) const 🔗
Devuelve true si el punto de código dado es una letra válida, es decir, pertenece a la categoría Unicode "L".
bool load_support_data(filename: String) 🔗
Carga una base de datos opcional de TextServer (p. ej. iteradores de salto y diccionarios ICU).
Nota: Esta función debería ser llamada antes que cualquier otra función de TextServer, de lo contrario no tendrá ningún efecto.
int name_to_tag(name: String) const 🔗
Convierte el nombre legible dado de una característica, variación, script o idioma a una etiqueta de OpenType.
String parse_number(number: String, language: String = "") const 🔗
Obsoleto: Use TranslationServer.parse_number() instead.
Convierte number del sistema numeral usado en el language dado a arábigo occidental (0..9).
Si language es una string vacía, se usará la configuración regional activa.
Array[Vector3i] parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) const 🔗
Implementación predeterminada de la función de sobrescritura del algoritmo BiDi.
String percent_sign(language: String = "") const 🔗
Obsoleto: Use TranslationServer.get_percent_sign() instead.
Devuelve el signo de porcentaje utilizado en el language dado.
Si language es una string vacía, se usará la configuración regional activa.
bool save_support_data(filename: String) const 🔗
Guarda la base de datos opcional de TextServer (p. ej. iteradores de salto y diccionarios ICU) en el archivo.
Nota: Esta función se utiliza durante la exportación del proyecto, para incluir la base de datos de TextServer.
int shaped_get_run_count(shaped: RID) const 🔗
Devuelve el número de secuencias de texto de variables uniformes en el búfer.
Direction shaped_get_run_direction(shaped: RID, index: int) const 🔗
Devuelve la dirección de la secuencia de texto de index (en orden visual).
RID shaped_get_run_font_rid(shaped: RID, index: int) const 🔗
Devuelve el RID de la fuente de la secuencia de texto de index (en orden visual).
int shaped_get_run_font_size(shaped: RID, index: int) const 🔗
Devuelve el tamaño de fuente de la secuencia de texto de index (en orden visual).
Vector2i shaped_get_run_glyph_range(shaped: RID, index: int) const 🔗
Returns the glyph range of the index text run (in visual order).
String shaped_get_run_language(shaped: RID, index: int) const 🔗
Devuelve el idioma del texto index ejecutado (en orden visual).
Variant shaped_get_run_object(shaped: RID, index: int) const 🔗
Devuelve el objeto incrustado de la ejecución de texto index (en orden visual).
Vector2i shaped_get_run_range(shaped: RID, index: int) const 🔗
Devuelve el rango de texto de origen de la secuencia de texto de index (en orden visual).
String shaped_get_run_text(shaped: RID, index: int) const 🔗
Devuelve el texto de origen de la secuencia de texto de index (en orden visual).
int shaped_get_span_count(shaped: RID) const 🔗
Devuelve el número de tramos de texto añadidos usando shaped_text_add_string() o shaped_text_add_object().
Variant shaped_get_span_embedded_object(shaped: RID, index: int) const 🔗
Devuelve la clave del objeto incrustado en el texto.
Variant shaped_get_span_meta(shaped: RID, index: int) const 🔗
Devuelve metadatos del intervalo de texto.
Variant shaped_get_span_object(shaped: RID, index: int) const 🔗
Devuelve la clave del objeto incrustado en el espacio de texto.
String shaped_get_span_text(shaped: RID, index: int) const 🔗
Devuelve el texto de origen del tramo de texto.
String shaped_get_text(shaped: RID) const 🔗
Devuelve el texto de origen del búfer de texto, incluyendo los caracteres de reemplazo de objeto.
void shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary = {}) 🔗
Cambia la fuente, el tamaño de la fuente y las características OpenType del tramo de texto, sin cambiar el texto.
bool shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment = 5, length: int = 1, baseline: float = 0.0) 🔗
Añade un objeto en línea al buffer de texto, key debe ser único. En el texto, el objeto se representa como length caracteres de reemplazo de objeto.
bool shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary = {}, language: String = "", meta: Variant = null) 🔗
Agrega espacio de texto y fuente para dibujarlo en el búfer de texto.
void shaped_text_clear(rid: RID) 🔗
Limpia el búfer de texto (elimina el texto y los objetos en línea).
int shaped_text_closest_character_pos(shaped: RID, pos: int) const 🔗
Devuelve la posición del carácter compuesto más cercana a pos.
void shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float = -1, clip_r: float = -1, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗
Dibuja el texto conformado en un elemento del canvas en una posición dada, con color. pos especifica el punto más a la izquierda de la línea base (para el diseño horizontal) o el punto más alto de la línea base (para el diseño vertical). Si oversampling es mayor que cero, se utiliza como factor de sobremuestreo de la fuente, de lo contrario, se utiliza la configuración de sobremuestreo del viewport.
clip_l y clip_r son desplazamientos relativos a pos, yendo hacia la derecha en el diseño horizontal y hacia abajo en el diseño vertical. Si clip_l no es negativo, los glifos que comienzan antes del desplazamiento se recortan. Si clip_r no es negativo, los glifos que terminan después del desplazamiento se recortan.
void shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float = -1, clip_r: float = -1, outline_size: int = 1, color: Color = Color(1, 1, 1, 1), oversampling: float = 0.0) const 🔗
Dibuja el contorno del texto conformado en un elemento del canvas en una posición dada, con color. pos especifica el punto más a la izquierda de la línea base (para el diseño horizontal) o el punto más alto de la línea base (para el diseño vertical). Si oversampling es mayor que cero, se utiliza como factor de sobremuestreo de la fuente, de lo contrario, se utiliza la configuración de sobremuestreo del viewport.
clip_l y clip_r son desplazamientos relativos a pos, yendo hacia la derecha en el diseño horizontal y hacia abajo en el diseño vertical. Si clip_l no es negativo, los glifos que comienzan antes del desplazamiento se recortan. Si clip_r no es negativo, los glifos que terminan después del desplazamiento se recortan.
RID shaped_text_duplicate(rid: RID) 🔗
Duplica el búfer de texto conformado.
float shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag] = 3) 🔗
Ajusta el ancho del texto para que encaje en el ancho especificado, devuelve el nuevo ancho del texto.
float shaped_text_get_ascent(shaped: RID) const 🔗
Devuelve el ascenso del texto (número de píxeles por encima de la línea de base para el diseño horizontal o a la izquierda de la línea de base para el vertical).
Nota: El ascenso total puede ser mayor que el ascenso de la fuente, si algunos glifos se desplazan desde la línea de base.
Dictionary shaped_text_get_carets(shaped: RID, position: int) const 🔗
Devuelve las formas de los cursores de texto correspondientes al desplazamiento de caracteres position en el texto. La forma del cursor devuelta es un rectángulo de 1 píxel de ancho.
PackedInt32Array shaped_text_get_character_breaks(shaped: RID) const 🔗
Devuelve un array de los límites de los caracteres compuestos.
int shaped_text_get_custom_ellipsis(shaped: RID) const 🔗
Devuelve el carácter de elipsis utilizado para el recorte de texto.
String shaped_text_get_custom_punctuation(shaped: RID) const 🔗
Devuelve la lista de caracteres de puntuación personalizados, utilizada para el salto de palabra. Si se establece como una string vacía, se utilizan los valores predeterminados del servidor.
float shaped_text_get_descent(shaped: RID) const 🔗
Devuelve el descenso del texto (número de píxeles por debajo de la línea de base para el diseño horizontal o a la derecha de la línea de base para el vertical).
Nota: El descenso total puede ser mayor que el descenso de la fuente, si algunos glifos se desplazan desde la línea de base.
Direction shaped_text_get_direction(shaped: RID) const 🔗
Devuelve la dirección del texto.
Direction shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) const 🔗
Devuelve la dirección dominante en el rango del texto.
int shaped_text_get_ellipsis_glyph_count(shaped: RID) const 🔗
Devuelve el número de glifos en la elipsis.
Array[Dictionary] shaped_text_get_ellipsis_glyphs(shaped: RID) const 🔗
Devuelve el array de glifos en la elipsis.
int shaped_text_get_ellipsis_pos(shaped: RID) const 🔗
Devuelve la posición de la elipsis.
int shaped_text_get_glyph_count(shaped: RID) const 🔗
Devuelve el número de glifos en el búfer.
Array[Dictionary] shaped_text_get_glyphs(shaped: RID) const 🔗
Devuelve un array de glifos en el orden visual.
Vector2 shaped_text_get_grapheme_bounds(shaped: RID, pos: int) const 🔗
Devuelve los límites del carácter compuesto como desplazamientos desde el inicio de la línea.
Direction shaped_text_get_inferred_direction(shaped: RID) const 🔗
Devuelve la dirección del texto, inferida por el algoritmo BiDi.
PackedInt32Array shaped_text_get_line_breaks(shaped: RID, width: float, start: int = 0, break_flags: BitField[LineBreakFlag] = 3) const 🔗
Divide el texto en líneas y devuelve los rangos de caracteres para cada línea.
PackedInt32Array shaped_text_get_line_breaks_adv(shaped: RID, width: PackedFloat32Array, start: int = 0, once: bool = true, break_flags: BitField[LineBreakFlag] = 3) const 🔗
Divide el texto en líneas y columnas. Devuelve los rangos de caracteres para cada segmento.
int shaped_text_get_object_glyph(shaped: RID, key: Variant) const 🔗
Devuelve el índice de glifo del objeto en la línea.
Vector2i shaped_text_get_object_range(shaped: RID, key: Variant) const 🔗
Devuelve el rango de caracteres del objeto en línea.
Rect2 shaped_text_get_object_rect(shaped: RID, key: Variant) const 🔗
Devuelve el rectángulo delimitador del objeto en línea.
Array shaped_text_get_objects(shaped: RID) const 🔗
Devuelve un array de objetos en la línea.
Orientation shaped_text_get_orientation(shaped: RID) const 🔗
Devuelve la orientación del texto.
RID shaped_text_get_parent(shaped: RID) const 🔗
Devuelve el búfer padre del que se origina la subcadena.
bool shaped_text_get_preserve_control(shaped: RID) const 🔗
Devuelve true si el búfer de texto está configurado para mostrar caracteres de control.
bool shaped_text_get_preserve_invalid(shaped: RID) const 🔗
Devuelve true si el búfer de texto está configurado para mostrar códigos hexadecimales en lugar de caracteres no válidos.
Nota: Si se establece en false, no se muestra nada en lugar de los caracteres no válidos.
Vector2i shaped_text_get_range(shaped: RID) const 🔗
Devuelve el rango de caracteres del búfer de la subcadena en el búfer padre.
PackedVector2Array shaped_text_get_selection(shaped: RID, start: int, end: int) const 🔗
Devuelve los rectángulos de selección para el rango de caracteres especificado.
Vector2 shaped_text_get_size(shaped: RID) const 🔗
Devuelve el tamaño del texto.
int shaped_text_get_spacing(shaped: RID, spacing: SpacingType) const 🔗
Devuelve el espaciado extra añadido entre glifos o líneas en píxeles.
int shaped_text_get_trim_pos(shaped: RID) const 🔗
Devuelve la posición del recorte de desbordamiento.
float shaped_text_get_underline_position(shaped: RID) const 🔗
Devuelve el desplazamiento de píxeles del subrayado debajo de la línea base.
float shaped_text_get_underline_thickness(shaped: RID) const 🔗
Devuelve el grosor del subrayado.
float shaped_text_get_width(shaped: RID) const 🔗
Devuelve el ancho (para diseño horizontal) o la altura (para vertical) del texto.
PackedInt32Array shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag] = 264, skip_grapheme_flags: BitField[GraphemeFlag] = 4) const 🔗
Divide el texto en palabras y devuelve un array de rangos de caracteres. Usa grapheme_flags para establecer qué caracteres se usan para la división.
bool shaped_text_has_object(shaped: RID, key: Variant) const 🔗
Devuelve true si un objeto con key está incrustado en este búfer de texto moldeado.
bool shaped_text_has_visible_chars(shaped: RID) const 🔗
Devuelve true si el búfer de texto contiene algún carácter visible.
int shaped_text_hit_test_grapheme(shaped: RID, coords: float) const 🔗
Devuelve el índice del grafema en el desplazamiento de píxel especificado en la línea de base, o -1 si no se encuentra ninguno.
int shaped_text_hit_test_position(shaped: RID, coords: float) const 🔗
Devuelve el desplazamiento del cursor en el píxel especificado en la línea base. Esta función siempre devuelve una posición válida.
bool shaped_text_is_ready(shaped: RID) const 🔗
Devuelve true si el búfer se ha conformado correctamente.
int shaped_text_next_character_pos(shaped: RID, pos: int) const 🔗
Devuelve la posición final del carácter compuesto más cercana a pos.
int shaped_text_next_grapheme_pos(shaped: RID, pos: int) const 🔗
Devuelve la posición final del grafema más cercana a pos.
void shaped_text_overrun_trim_to_width(shaped: RID, width: float = 0, overrun_trim_flags: BitField[TextOverrunFlag] = 0) 🔗
Recorta el texto si excede el ancho dado.
int shaped_text_prev_character_pos(shaped: RID, pos: int) const 🔗
Devuelve la posición inicial del carácter compuesto más cercana a pos.
int shaped_text_prev_grapheme_pos(shaped: RID, pos: int) const 🔗
Devuelve la posición inicial del grafema más cercana a pos.
bool shaped_text_resize_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment = 5, baseline: float = 0.0) 🔗
Establece el nuevo tamaño y alineación del objeto incrustado.
void shaped_text_set_bidi_override(shaped: RID, override: Array) 🔗
Sobreescribe BiDi para el texto estructurado.
Los rangos de sobreescritura deben cubrir el texto fuente completo sin superposiciones. El algoritmo BiDi se utilizará en cada rango por separado.
void shaped_text_set_custom_ellipsis(shaped: RID, char: int) 🔗
Establece el carácter de elipsis usado para el recorte de texto.
void shaped_text_set_custom_punctuation(shaped: RID, punct: String) 🔗
Establece una lista de caracteres de puntuación personalizada, utilizada para el salto de palabra. Si se establece como una string vacía, se utilizarán los valores predeterminados del servidor.
void shaped_text_set_direction(shaped: RID, direction: Direction = 0) 🔗
Establece la dirección de texto deseada. Si se establece a DIRECTION_AUTO, la dirección se detectará basándose en el contenido del búfer y la configuración regional actual.
Nota: La dirección se ignora si el servidor no es compatible con la característica FEATURE_BIDI_LAYOUT (compatible con TextServerAdvanced).
void shaped_text_set_orientation(shaped: RID, orientation: Orientation = 0) 🔗
Establece la orientación del texto deseada.
Nota: La orientación se ignora si el servidor no es compatible con la característica FEATURE_VERTICAL_LAYOUT (compatible con TextServerAdvanced).
void shaped_text_set_preserve_control(shaped: RID, enabled: bool) 🔗
Si se establece a true, el búfer de texto mostrará los caracteres de control.
void shaped_text_set_preserve_invalid(shaped: RID, enabled: bool) 🔗
Si se establece a true, el búfer de texto mostrará los caracteres no válidos como códigos hexadecimales. De lo contrario, no se mostrará nada.
void shaped_text_set_spacing(shaped: RID, spacing: SpacingType, value: int) 🔗
Establece el espaciado extra añadido entre glifos o líneas en píxeles.
bool shaped_text_shape(shaped: RID) 🔗
Da forma al búfer si no la tiene. Devuelve true si la string se conforma con éxito.
Nota: No es necesario llamar a esta función manualmente, el búfer se conformará automáticamente tan pronto como se solicite cualquiera de sus datos de salida.
Array[Dictionary] shaped_text_sort_logical(shaped: RID) 🔗
Devuelve los glifos de texto en orden lógico.
RID shaped_text_substr(shaped: RID, start: int, length: int) const 🔗
Devuelve un búfer de texto para la subcadena de texto en el búfer de texto shaped (incluyendo objetos en línea).
float shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) 🔗
Alinea el texto conformado a las tabulaciones dadas.
bool spoof_check(string: String) const 🔗
Devuelve true si es probable que string sea un intento de confundir al lector.
Nota: Siempre devuelve false si el servidor no soporta la característica FEATURE_UNICODE_SECURITY.
PackedInt32Array string_get_character_breaks(string: String, language: String = "") const 🔗
Devuelve un array de los límites de los caracteres compuestos.
var ts = TextServerManager.get_primary_interface()
print(ts.string_get_character_breaks("Prueba ❤️🔥 Prueba")) # Imprime [1, 2, 3, 4, 5, 6, 7, 11, 12, 13, 14, 15, 16, 17, 18]
PackedInt32Array string_get_word_breaks(string: String, language: String = "", chars_per_line: int = 0) const 🔗
Devuelve un array de los límites de saltos de palabra. Los elementos del array devuelto son los desplazamientos del inicio y el final de las palabras. Por lo tanto, la longitud del array es siempre par.
Cuando chars_per_line es mayor que cero, se devuelven en su lugar los límites de salto de línea.
var ts = TextServerManager.get_primary_interface()
# Corresponde a las subcadenas "The", "Godot", "Engine", y "4".
print(ts.string_get_word_breaks("The Godot Engine, 4")) # Imprime [0, 3, 4, 9, 10, 16, 18, 19]
# Corresponde a las subcadenas "The", "Godot", "Engin", y "e, 4".
print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Imprime [0, 3, 4, 9, 10, 15, 15, 19]
# Corresponde a las subcadenas "The Godot" y "Engine, 4".
print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Imprime [0, 9, 10, 19]
String string_to_lower(string: String, language: String = "") const 🔗
Devuelve la string convertida a lowercase.
Nota: El uso de mayúsculas y minúsculas depende de la configuración regional y del contexto si el servidor soporta la característica FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION (soportada por TextServerAdvanced).
Nota: El resultado puede ser más largo o más corto que el original.
String string_to_title(string: String, language: String = "") const 🔗
Devuelve la string convertida a Title Case.
Nota: El uso de mayúsculas y minúsculas depende de la configuración regional y del contexto si el servidor soporta la característica FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION (soportada por TextServerAdvanced).
Nota: El resultado puede ser más largo o más corto que el original.
String string_to_upper(string: String, language: String = "") const 🔗
Returns the string converted to UPPERCASE.
Note: Casing is locale dependent and context sensitive if server support FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION feature (supported by TextServerAdvanced).
Note: The result may be longer or shorter than the original.
String strip_diacritics(string: String) const 🔗
Elimina los diacríticos de la string.
Nota: El resultado puede ser más largo o más corto que el original.
String tag_to_name(tag: int) const 🔗
Converts the given OpenType tag to the readable name of a feature, variation, script, or language.