class-description NEWS COMMUNITY STORE LABS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE LABS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCounted TextServer
A server interface for font management and text rendering.

TextServer is the API backend for managing fonts and rendering text.

 Enum FontAntialiasing<>():Enum

FONT_ANTIALIASING_NONE = 0

Font glyphs are rasterized as 1-bit bitmaps.


FONT_ANTIALIASING_GRAY = 1

Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.


FONT_ANTIALIASING_LCD = 2

Font glyphs are rasterized for LCD screens.

 Enum FontLCDSubpixelLayout<>():Enum

FONT_LCD_SUBPIXEL_LAYOUT_NONE = 0

Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.


FONT_LCD_SUBPIXEL_LAYOUT_HRGB = 1

Horizontal RGB subpixel layout.


FONT_LCD_SUBPIXEL_LAYOUT_HBGR = 2

Horizontal BGR subpixel layout.


FONT_LCD_SUBPIXEL_LAYOUT_VRGB = 3

Vertical RGB subpixel layout.


FONT_LCD_SUBPIXEL_LAYOUT_VBGR = 4

Vertical BGR subpixel layout.


FONT_LCD_SUBPIXEL_LAYOUT_MAX = 5

Represents the size of the FontLCDSubpixelLayout enum.

 Enum Direction<>():Enum

DIRECTION_AUTO = 0

Text direction is determined based on contents and current locale.


DIRECTION_LTR = 1

Text is written from left to right.


DIRECTION_RTL = 2

Text is written from right to left.


DIRECTION_INHERITED = 3

Text writing direction is the same as base string writing direction. Used for BiDi override only.

 Enum Orientation<>():Enum

ORIENTATION_HORIZONTAL = 0

Text is written horizontally.


ORIENTATION_VERTICAL = 1

Left to right text is written vertically from top to bottom.

 Enum JustificationFlag<>():Enum

JUSTIFICATION_NONE = 0

Do not justify text.


JUSTIFICATION_KASHIDA = 1

Justify text by adding and removing kashidas.


JUSTIFICATION_WORD_BOUND = 2

Justify text by changing width of the spaces between the words.


JUSTIFICATION_TRIM_EDGE_SPACES = 4

Remove trailing and leading spaces from the justified text.


JUSTIFICATION_AFTER_LAST_TAB = 8

Only apply justification to the part of the text after the last tab.


JUSTIFICATION_CONSTRAIN_ELLIPSIS = 16

Apply justification to the trimmed line with ellipsis.


JUSTIFICATION_SKIP_LAST_LINE = 32

Do not apply justification to the last line of the paragraph.


JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 64

Do not apply justification to the last line of the paragraph with visible characters (takes precedence over JUSTIFICATION_SKIP_LAST_LINE).


JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 128

Always apply justification to the paragraphs with a single line (JUSTIFICATION_SKIP_LAST_LINE and JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS are ignored).

 Enum AutowrapMode<>():Enum

AUTOWRAP_OFF = 0

Autowrap is disabled.


AUTOWRAP_ARBITRARY = 1

Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.


AUTOWRAP_WORD = 2

Wraps the text inside the node's bounding rectangle by soft-breaking between words.


AUTOWRAP_WORD_SMART = 3

Behaves similarly to AUTOWRAP_WORD, but force-breaks a word if that single word does not fit in one line.

 Enum LineBreakFlag<>():Enum

BREAK_NONE = 0

Do not break the line.


BREAK_MANDATORY = 1

Break the line at the line mandatory break characters (e.g. "\n").


BREAK_WORD_BOUND = 2

Break the line between the words.


BREAK_GRAPHEME_BOUND = 4

Break the line between any unconnected graphemes.


BREAK_ADAPTIVE = 8

Should be used only in conjunction with BREAK_WORD_BOUND, break the line between any unconnected graphemes, if it's impossible to break it between the words.


BREAK_TRIM_EDGE_SPACES = 16

Remove edge spaces from the broken line segments.

 Enum VisibleCharactersBehavior<>():Enum

VC_CHARS_BEFORE_SHAPING = 0

Trims text before the shaping. e.g, increasing Label.visible_characters or RichTextLabel.visible_characters value is visually identical to typing the text.


VC_CHARS_AFTER_SHAPING = 1

Displays glyphs that are mapped to the first Label.visible_characters or RichTextLabel.visible_characters characters from the beginning of the text.


VC_GLYPHS_AUTO = 2

Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the left or from the right, depending on Control.layout_direction value.


VC_GLYPHS_LTR = 3

Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the left.


VC_GLYPHS_RTL = 4

Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the right.

 Enum OverrunBehavior<>():Enum

OVERRUN_NO_TRIMMING = 0

No text trimming is performed.


OVERRUN_TRIM_CHAR = 1

Trims the text per character.


OVERRUN_TRIM_WORD = 2

Trims the text per word.


OVERRUN_TRIM_ELLIPSIS = 3

Trims the text per character and adds an ellipsis to indicate that parts are hidden.


OVERRUN_TRIM_WORD_ELLIPSIS = 4

Trims the text per word and adds an ellipsis to indicate that parts are hidden.

 Enum TextOverrunFlag<>():Enum

OVERRUN_NO_TRIM = 0

No trimming is performed.


OVERRUN_TRIM = 1

Trims the text when it exceeds the given width.


OVERRUN_TRIM_WORD_ONLY = 2

Trims the text per word instead of per grapheme.


OVERRUN_ADD_ELLIPSIS = 4

Determines whether an ellipsis should be added at the end of the text.


OVERRUN_ENFORCE_ELLIPSIS = 8

Determines whether the ellipsis at the end of the text is enforced and may not be hidden.


OVERRUN_JUSTIFICATION_AWARE = 16

Accounts for the text being justified before attempting to trim it (see JustificationFlag).

 Enum GraphemeFlag<>():Enum

GRAPHEME_IS_VALID = 1

Grapheme is supported by the font, and can be drawn.


GRAPHEME_IS_RTL = 2

Grapheme is part of right-to-left or bottom-to-top run.


GRAPHEME_IS_VIRTUAL = 4

Grapheme is not part of source text, it was added by justification process.


GRAPHEME_IS_SPACE = 8

Grapheme is whitespace.


GRAPHEME_IS_BREAK_HARD = 16

Grapheme is mandatory break point (e.g. "\n").


GRAPHEME_IS_BREAK_SOFT = 32

Grapheme is optional break point (e.g. space).


GRAPHEME_IS_TAB = 64

Grapheme is the tabulation character.


GRAPHEME_IS_ELONGATION = 128

Grapheme is kashida.


GRAPHEME_IS_PUNCTUATION = 256

Grapheme is punctuation character.


GRAPHEME_IS_UNDERSCORE = 512

Grapheme is underscore character.


GRAPHEME_IS_CONNECTED = 1024

Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.


GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 2048

It is safe to insert a U+0640 before this grapheme for elongation.


GRAPHEME_IS_EMBEDDED_OBJECT = 4096

Grapheme is an object replacement character for the embedded object.

 Enum Hinting<>():Enum

HINTING_NONE = 0

Disables font hinting (smoother but less crisp).


HINTING_LIGHT = 1

Use the light font hinting mode.


HINTING_NORMAL = 2

Use the default font hinting mode (crisper but less smooth).

 Enum SubpixelPositioning<>():Enum

SUBPIXEL_POSITIONING_DISABLED = 0

Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.


SUBPIXEL_POSITIONING_AUTO = 1

Glyph horizontal position is rounded based on font size.


SUBPIXEL_POSITIONING_ONE_HALF = 2

Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.


SUBPIXEL_POSITIONING_ONE_QUARTER = 3

Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.


SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20

Maximum font size which will use one half of the pixel subpixel positioning in SUBPIXEL_POSITIONING_AUTO mode.


SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16

Maximum font size which will use one quarter of the pixel subpixel positioning in SUBPIXEL_POSITIONING_AUTO mode.

 Enum Feature<>():Enum

FEATURE_SIMPLE_LAYOUT = 1

TextServer supports simple text layouts.


FEATURE_BIDI_LAYOUT = 2

TextServer supports bidirectional text layouts.


FEATURE_VERTICAL_LAYOUT = 4

TextServer supports vertical layouts.


FEATURE_SHAPING = 8

TextServer supports complex text shaping.


FEATURE_KASHIDA_JUSTIFICATION = 16

TextServer supports justification using kashidas.


FEATURE_BREAK_ITERATORS = 32

TextServer supports complex line/word breaking rules (e.g. dictionary based).


FEATURE_FONT_BITMAP = 64

TextServer supports loading bitmap fonts.


FEATURE_FONT_DYNAMIC = 128

TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.


FEATURE_FONT_MSDF = 256

TextServer supports multichannel signed distance field dynamic font rendering.


FEATURE_FONT_SYSTEM = 512

TextServer supports loading system fonts.


FEATURE_FONT_VARIABLE = 1024

TextServer supports variable fonts.


FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 2048

TextServer supports locale dependent and context sensitive case conversion.


FEATURE_USE_SUPPORT_DATA = 4096

TextServer require external data file for some features, see load_support_data.


FEATURE_UNICODE_IDENTIFIERS = 8192

TextServer supports UAX #31 identifier validation, see is_valid_identifier.


FEATURE_UNICODE_SECURITY = 16384

TextServer supports Unicode Technical Report #36 and Unicode Technical Standard #39 based spoof detection features.

 Enum ContourPointTag<>():Enum

CONTOUR_CURVE_TAG_ON = 1

Contour point is on the curve.


CONTOUR_CURVE_TAG_OFF_CONIC = 0

Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.


CONTOUR_CURVE_TAG_OFF_CUBIC = 2

Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.

 Enum SpacingType<>():Enum

SPACING_GLYPH = 0

Spacing for each glyph.


SPACING_SPACE = 1

Spacing for the space character.


SPACING_TOP = 2

Spacing at the top of the line.


SPACING_BOTTOM = 3

Spacing at the bottom of the line.


SPACING_MAX = 4

Represents the size of the SpacingType enum.

 Enum FontStyle<>():Enum

FONT_BOLD = 1

Font is bold.


FONT_ITALIC = 2

Font is italic or oblique.


FONT_FIXED_WIDTH = 4

Font have fixed-width characters.

 Enum StructuredTextParser<>():Enum

STRUCTURED_TEXT_DEFAULT = 0

Use default Unicode BiDi algorithm.


STRUCTURED_TEXT_URI = 1

BiDi override for URI.


STRUCTURED_TEXT_FILE = 2

BiDi override for file path.


STRUCTURED_TEXT_EMAIL = 3

BiDi override for email.


STRUCTURED_TEXT_LIST = 4

BiDi override for lists. Structured text options: list separator String.


STRUCTURED_TEXT_GDSCRIPT = 5

BiDi override for GDScript.


STRUCTURED_TEXT_CUSTOM = 6

User defined structured text BiDi override function.

 Enum FixedSizeScaleMode<>():Enum

FIXED_SIZE_SCALE_DISABLE = 0

Bitmap font is not scaled.


FIXED_SIZE_SCALE_INTEGER_ONLY = 1

Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.


FIXED_SIZE_SCALE_ENABLED = 2

Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.

 RID create_font<>():RID

Creates a new, empty font cache entry resource. To free the resulting resource, use the free_rid method.

 RID create_font_linked_variation<>( RID font_rid=, font_rid:RID=, ):RID

Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the free_rid method.

 RID create_shaped_text<>( Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):RID

Creates new buffer for complex text layout, with the given direction and orientation. To free the resulting buffer, use free_rid method.

Note: Direction is ignored if server does not support FEATURE_BIDI_LAYOUT feature (supported by TextServerAdvanced).

Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextServerAdvanced).

 void draw_hex_code_box<>( RID canvas=, canvas:RID=, int size=, size:int=, Vector2 pos=, pos:Vector2=, int index=, index:int=, Color color=, color:Color=, ):void

Draws box displaying character hexadecimal code. Used for replacing missing characters.

 void font_clear_glyphs<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, ):void

Removes all rendered glyphs information from the cache entry.

Note: This function will not remove textures associated with the glyphs, use font_remove_texture to remove them manually.

 void font_clear_kerning_map<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):void

Removes all kerning overrides.

 void font_clear_size_cache<>( RID font_rid=, font_rid:RID=, ):void

Removes all font sizes from the cache entry.

 void font_clear_textures<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, ):void

Removes all textures from font cache entry.

Note: This function will not remove glyphs associated with the texture, use font_remove_glyph to remove them manually.

 void font_draw_glyph<>( RID font_rid=, font_rid:RID=, RID canvas=, canvas:RID=, int size=, size:int=, Vector2 pos=, pos:Vector2=, int index=, index:int=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):void

Draws single glyph into a canvas item at the position, using font_rid at the size size.

Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs or font_get_glyph_index.

Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

 void font_draw_glyph_outline<>( RID font_rid=, font_rid:RID=, RID canvas=, canvas:RID=, int size=, size:int=, int outline_size=, outline_size:int=, Vector2 pos=, pos:Vector2=, int index=, index:int=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):void

Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size.

Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs or font_get_glyph_index.

Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

 FontAntialiasing font_get_antialiasing<>( RID font_rid=, font_rid:RID=, ):FontAntialiasing

Returns font anti-aliasing mode.

 float font_get_ascent<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):float

Returns the font ascent (number of pixels above the baseline).

 float font_get_baseline_offset<>( RID font_rid=, font_rid:RID=, ):float

Returns extra baseline offset (as a fraction of font height).

 int font_get_char_from_glyph_index<>( RID font_rid=, font_rid:RID=, int size=, size:int=, int glyph_index=, glyph_index:int=, ):int

Returns character code associated with glyph_index, or 0 if glyph_index is invalid. See font_get_glyph_index.

 float font_get_descent<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):float

Returns the font descent (number of pixels below the baseline).

 float font_get_embolden<>( RID font_rid=, font_rid:RID=, ):float

Returns font embolden strength.

 int font_get_face_count<>( RID font_rid=, font_rid:RID=, ):int

Returns number of faces in the TrueType / OpenType collection.

 int font_get_face_index<>( RID font_rid=, font_rid:RID=, ):int

Returns an active face index in the TrueType / OpenType collection.

 int font_get_fixed_size<>( RID font_rid=, font_rid:RID=, ):int

Returns bitmap font fixed size.

 FixedSizeScaleMode font_get_fixed_size_scale_mode<>( RID font_rid=, font_rid:RID=, ):FixedSizeScaleMode

Returns bitmap font scaling mode.

 bool font_get_generate_mipmaps<>( RID font_rid=, font_rid:RID=, ):bool

Returns true if font texture mipmap generation is enabled.

 float font_get_global_oversampling<>():float

Returns the font oversampling factor, shared by all fonts in the TextServer.

 Vector2 font_get_glyph_advance<>( RID font_rid=, font_rid:RID=, int size=, size:int=, int glyph=, glyph:int=, ):Vector2

Returns glyph advance (offset of the next glyph).

Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

 Dictionary font_get_glyph_contours<>( RID font=, font:RID=, int size=, size:int=, int index=, index:int=, ):Dictionary

Returns outline contours of the glyph as a Dictionary with the following contents:

points - PackedVector3Array, containing outline points. x and y are point coordinates. z is the type of the point, using the ContourPointTag values.

contours - PackedInt32Array, containing indices the end points of each contour.

orientation - bool, contour orientation. If true, clockwise contours must be filled.

 int font_get_glyph_index<>( RID font_rid=, font_rid:RID=, int size=, size:int=, int char=, char:int=, int variation_selector=, variation_selector:int=, ):int

Returns the glyph index of a char, optionally modified by the variation_selector. See font_get_char_from_glyph_index.

 PackedInt32Array font_get_glyph_list<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, ):PackedInt32Array

Returns list of rendered glyphs in the cache entry.

 Vector2 font_get_glyph_offset<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):Vector2

Returns glyph offset from the baseline.

 Vector2 font_get_glyph_size<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):Vector2

Returns size of the glyph.

 int font_get_glyph_texture_idx<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):int

Returns index of the cache texture containing the glyph.

 RID font_get_glyph_texture_rid<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):RID

Returns resource ID of the cache texture containing the glyph.

Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

 Vector2 font_get_glyph_texture_size<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):Vector2

Returns size of the cache texture containing the glyph.

Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

 Rect2 font_get_glyph_uv_rect<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):Rect2

Returns rectangle in the cache texture containing the glyph.

 Hinting font_get_hinting<>( RID font_rid=, font_rid:RID=, ):Hinting

Returns the font hinting mode. Used by dynamic fonts only.

 Vector2 font_get_kerning<>( RID font_rid=, font_rid:RID=, int size=, size:int=, Vector2i glyph_pair=, glyph_pair:Vector2i=, ):Vector2

Returns kerning for the pair of glyphs.

 Vector2i[] font_get_kerning_list<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):Vector2i[]

Returns list of the kerning overrides.

 bool font_get_language_support_override<>( RID font_rid=, font_rid:RID=, String language=, language:String=, ):bool

Returns true if support override is enabled for the language.

 PackedStringArray font_get_language_support_overrides<>( RID font_rid=, font_rid:RID=, ):PackedStringArray

Returns list of language support overrides.

 int font_get_msdf_pixel_range<>( RID font_rid=, font_rid:RID=, ):int

Returns the width of the range around the shape between the minimum and maximum representable signed distance.

 int font_get_msdf_size<>( RID font_rid=, font_rid:RID=, ):int

Returns source font size used to generate MSDF textures.

 String font_get_name<>( RID font_rid=, font_rid:RID=, ):String

Returns font family name.

 Dictionary font_get_opentype_feature_overrides<>( RID font_rid=, font_rid:RID=, ):Dictionary

Returns font OpenType feature set override.

 Dictionary font_get_ot_name_strings<>( RID font_rid=, font_rid:RID=, ):Dictionary

Returns Dictionary with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).

 float font_get_oversampling<>( RID font_rid=, font_rid:RID=, ):float

Returns font oversampling factor, if set to 0.0 global oversampling factor is used instead. Used by dynamic fonts only.

 float font_get_scale<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):float

Returns scaling factor of the color bitmap font.

 bool font_get_script_support_override<>( RID font_rid=, font_rid:RID=, String script=, script:String=, ):bool

Returns true if support override is enabled for the script.

 PackedStringArray font_get_script_support_overrides<>( RID font_rid=, font_rid:RID=, ):PackedStringArray

Returns list of script support overrides.

 Vector2i[] font_get_size_cache_list<>( RID font_rid=, font_rid:RID=, ):Vector2i[]

Returns list of the font sizes in the cache. Each size is Vector2i with font size and outline size.

 int font_get_spacing<>( RID font_rid=, font_rid:RID=, SpacingType spacing=, spacing:SpacingType=, ):int

Returns the spacing for spacing (see SpacingType) in pixels (not relative to the font size).

 int font_get_stretch<>( RID font_rid=, font_rid:RID=, ):int

Returns font stretch amount, compared to a normal width. A percentage value between 50% and 200%.

 BitField font_get_style<>( RID font_rid=, font_rid:RID=, ):BitField

Returns font style flags, see FontStyle.

 String font_get_style_name<>( RID font_rid=, font_rid:RID=, ):String

Returns font style name.

 SubpixelPositioning font_get_subpixel_positioning<>( RID font_rid=, font_rid:RID=, ):SubpixelPositioning

Returns font subpixel glyph positioning mode.

 String font_get_supported_chars<>( RID font_rid=, font_rid:RID=, ):String

Returns a string containing all the characters available in the font.

 int font_get_texture_count<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, ):int

Returns number of textures used by font cache entry.

 Image font_get_texture_image<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int texture_index=, texture_index:int=, ):Image

Returns font cache texture image data.

 PackedInt32Array font_get_texture_offsets<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int texture_index=, texture_index:int=, ):PackedInt32Array

Returns array containing glyph packing data.

 Transform2D font_get_transform<>( RID font_rid=, font_rid:RID=, ):Transform2D

Returns 2D transform applied to the font outlines.

 float font_get_underline_position<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):float

Returns pixel offset of the underline below the baseline.

 float font_get_underline_thickness<>( RID font_rid=, font_rid:RID=, int size=, size:int=, ):float

Returns thickness of the underline in pixels.

 Dictionary font_get_variation_coordinates<>( RID font_rid=, font_rid:RID=, ):Dictionary

Returns variation coordinates for the specified font cache entry. See font_supported_variation_list for more info.

 int font_get_weight<>( RID font_rid=, font_rid:RID=, ):int

Returns weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700.

 bool font_has_char<>( RID font_rid=, font_rid:RID=, int char=, char:int=, ):bool

Returns true if a Unicode char is available in the font.

 bool font_is_allow_system_fallback<>( RID font_rid=, font_rid:RID=, ):bool

Returns true if system fonts can be automatically used as fallbacks.

 bool font_is_force_autohinter<>( RID font_rid=, font_rid:RID=, ):bool

Returns true if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.

 bool font_is_language_supported<>( RID font_rid=, font_rid:RID=, String language=, language:String=, ):bool

Returns true, if font supports given language (ISO 639 code).

 bool font_is_multichannel_signed_distance_field<>( RID font_rid=, font_rid:RID=, ):bool

Returns true if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.

 bool font_is_script_supported<>( RID font_rid=, font_rid:RID=, String script=, script:String=, ):bool

Returns true, if font supports given script (ISO 15924 code).

 void font_remove_glyph<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, ):void

Removes specified rendered glyph information from the cache entry.

Note: This function will not remove textures associated with the glyphs, use font_remove_texture to remove them manually.

 void font_remove_kerning<>( RID font_rid=, font_rid:RID=, int size=, size:int=, Vector2i glyph_pair=, glyph_pair:Vector2i=, ):void

Removes kerning override for the pair of glyphs.

 void font_remove_language_support_override<>( RID font_rid=, font_rid:RID=, String language=, language:String=, ):void

Remove language support override.

 void font_remove_script_support_override<>( RID font_rid=, font_rid:RID=, String script=, script:String=, ):void

Removes script support override.

 void font_remove_size_cache<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, ):void

Removes specified font size from the cache entry.

 void font_remove_texture<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int texture_index=, texture_index:int=, ):void

Removes specified texture from the cache entry.

Note: This function will not remove glyphs associated with the texture, remove them manually, using font_remove_glyph.

 void font_render_glyph<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int index=, index:int=, ):void

Renders specified glyph to the font cache texture.

 void font_render_range<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int start=, start:int=, int end=, end:int=, ):void

Renders the range of characters to the font cache texture.

 void font_set_allow_system_fallback<>( RID font_rid=, font_rid:RID=, bool allow_system_fallback=, allow_system_fallback:bool=, ):void

If set to true, system fonts can be automatically used as fallbacks.

 void font_set_antialiasing<>( RID font_rid=, font_rid:RID=, FontAntialiasing antialiasing=, antialiasing:FontAntialiasing=, ):void

Sets font anti-aliasing mode.

 void font_set_ascent<>( RID font_rid=, font_rid:RID=, int size=, size:int=, float ascent=, ascent:float=, ):void

Sets the font ascent (number of pixels above the baseline).

 void font_set_baseline_offset<>( RID font_rid=, font_rid:RID=, float baseline_offset=, baseline_offset:float=, ):void

Sets extra baseline offset (as a fraction of font height).

 void font_set_data<>( RID font_rid=, font_rid:RID=, PackedByteArray data=, data:PackedByteArray=, ):void

Sets font source data, e.g contents of the dynamic font source file.

 void font_set_descent<>( RID font_rid=, font_rid:RID=, int size=, size:int=, float descent=, descent:float=, ):void

Sets the font descent (number of pixels below the baseline).

 void font_set_embolden<>( RID font_rid=, font_rid:RID=, float strength=, strength:float=, ):void

Sets font embolden strength. If strength is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

 void font_set_face_index<>( RID font_rid=, font_rid:RID=, int face_index=, face_index:int=, ):void

Sets an active face index in the TrueType / OpenType collection.

 void font_set_fixed_size<>( RID font_rid=, font_rid:RID=, int fixed_size=, fixed_size:int=, ):void

Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.

 void font_set_fixed_size_scale_mode<>( RID font_rid=, font_rid:RID=, FixedSizeScaleMode fixed_size_scale_mode=, fixed_size_scale_mode:FixedSizeScaleMode=, ):void

Sets bitmap font scaling mode. This property is used only if fixed_size is greater than zero.

 void font_set_force_autohinter<>( RID font_rid=, font_rid:RID=, bool=, bool:=, ):void

If set to true auto-hinting is preferred over font built-in hinting.

 void font_set_generate_mipmaps<>( RID font_rid=, font_rid:RID=, bool generate_mipmaps=, generate_mipmaps:bool=, ):void

If set to true font texture mipmap generation is enabled.

 void font_set_global_oversampling<>( float oversampling=, oversampling:float=, ):void

Sets oversampling factor, shared by all font in the TextServer.

Note: This value can be automatically changed by display server.

 void font_set_glyph_advance<>( RID font_rid=, font_rid:RID=, int size=, size:int=, int glyph=, glyph:int=, Vector2 advance=, advance:Vector2=, ):void

Sets glyph advance (offset of the next glyph).

Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

 void font_set_glyph_offset<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, Vector2 offset=, offset:Vector2=, ):void

Sets glyph offset from the baseline.

 void font_set_glyph_size<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, Vector2 gl_size=, gl_size:Vector2=, ):void

Sets size of the glyph.

 void font_set_glyph_texture_idx<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, int texture_idx=, texture_idx:int=, ):void

Sets index of the cache texture containing the glyph.

 void font_set_glyph_uv_rect<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int glyph=, glyph:int=, Rect2 uv_rect=, uv_rect:Rect2=, ):void

Sets rectangle in the cache texture containing the glyph.

 void font_set_hinting<>( RID font_rid=, font_rid:RID=, Hinting hinting=, hinting:Hinting=, ):void

Sets font hinting mode. Used by dynamic fonts only.

 void font_set_kerning<>( RID font_rid=, font_rid:RID=, int size=, size:int=, Vector2i glyph_pair=, glyph_pair:Vector2i=, Vector2 kerning=, kerning:Vector2=, ):void

Sets kerning for the pair of glyphs.

 void font_set_language_support_override<>( RID font_rid=, font_rid:RID=, String language=, language:String=, bool supported=, supported:bool=, ):void

Adds override for font_is_language_supported.

 void font_set_msdf_pixel_range<>( RID font_rid=, font_rid:RID=, int msdf_pixel_range=, msdf_pixel_range:int=, ):void

Sets the width of the range around the shape between the minimum and maximum representable signed distance.

 void font_set_msdf_size<>( RID font_rid=, font_rid:RID=, int msdf_size=, msdf_size:int=, ):void

Sets source font size used to generate MSDF textures.

 void font_set_multichannel_signed_distance_field<>( RID font_rid=, font_rid:RID=, bool msdf=, msdf:bool=, ):void

If set to true, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.

Note: MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.

 void font_set_name<>( RID font_rid=, font_rid:RID=, String name=, name:String=, ):void

Sets the font family name.

 void font_set_opentype_feature_overrides<>( RID font_rid=, font_rid:RID=, Dictionary overrides=, overrides:Dictionary=, ):void

Sets font OpenType feature set override.

 void font_set_oversampling<>( RID font_rid=, font_rid:RID=, float oversampling=, oversampling:float=, ):void

Sets font oversampling factor, if set to 0.0 global oversampling factor is used instead. Used by dynamic fonts only.

 void font_set_scale<>( RID font_rid=, font_rid:RID=, int size=, size:int=, float scale=, scale:float=, ):void

Sets scaling factor of the color bitmap font.

 void font_set_script_support_override<>( RID font_rid=, font_rid:RID=, String script=, script:String=, bool supported=, supported:bool=, ):void

Adds override for font_is_script_supported.

 void font_set_spacing<>( RID font_rid=, font_rid:RID=, SpacingType spacing=, spacing:SpacingType=, int value=, value:int=, ):void

Sets the spacing for spacing (see SpacingType) to value in pixels (not relative to the font size).

 void font_set_stretch<>( RID font_rid=, font_rid:RID=, int weight=, weight:int=, ):void

Sets font stretch amount, compared to a normal width. A percentage value between 50% and 200%.

Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index, font_set_variation_coordinates, or font_set_transform instead.

 void font_set_style<>( RID font_rid=, font_rid:RID=, BitField=, BitField:=, ):void

Sets the font style flags, see FontStyle.

Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index, font_set_variation_coordinates, font_set_embolden, or font_set_transform instead.

 void font_set_style_name<>( RID font_rid=, font_rid:RID=, String name=, name:String=, ):void

Sets the font style name.

 void font_set_subpixel_positioning<>( RID font_rid=, font_rid:RID=, SubpixelPositioning subpixel_positioning=, subpixel_positioning:SubpixelPositioning=, ):void

Sets font subpixel glyph positioning mode.

 void font_set_texture_image<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int texture_index=, texture_index:int=, Image image=, image:Image=, ):void

Sets font cache texture image data.

 void font_set_texture_offsets<>( RID font_rid=, font_rid:RID=, Vector2i size=, size:Vector2i=, int texture_index=, texture_index:int=, PackedInt32Array offset=, offset:PackedInt32Array=, ):void

Sets array containing glyph packing data.

 void font_set_transform<>( RID font_rid=, font_rid:RID=, Transform2D transform=, transform:Transform2D=, ):void

Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.

For example, to simulate italic typeface by slanting, apply the following transform Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0).

 void font_set_underline_position<>( RID font_rid=, font_rid:RID=, int size=, size:int=, float underline_position=, underline_position:float=, ):void

Sets pixel offset of the underline below the baseline.

 void font_set_underline_thickness<>( RID font_rid=, font_rid:RID=, int size=, size:int=, float underline_thickness=, underline_thickness:float=, ):void

Sets thickness of the underline in pixels.

 void font_set_variation_coordinates<>( RID font_rid=, font_rid:RID=, Dictionary variation_coordinates=, variation_coordinates:Dictionary=, ):void

Sets variation coordinates for the specified font cache entry. See font_supported_variation_list for more info.

 void font_set_weight<>( RID font_rid=, font_rid:RID=, int weight=, weight:int=, ):void

Sets weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700.

Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index, font_set_variation_coordinates, or font_set_embolden instead.

 Dictionary font_supported_feature_list<>( RID font_rid=, font_rid:RID=, ):Dictionary

Returns the dictionary of the supported OpenType features.

 Dictionary font_supported_variation_list<>( RID font_rid=, font_rid:RID=, ):Dictionary

Returns the dictionary of the supported OpenType variation coordinates.

 String format_number<>( String number=, number:String=, String language="", language:String="", ):String

Converts a number from the Western Arabic (0..9) to the numeral systems used in language.

If language is omitted, the active locale will be used.

 void free_rid<>( RID rid=, rid:RID=, ):void

Frees an object created by this TextServer.

 int get_features<>():int

Returns text server features, see Feature.

 Vector2 get_hex_code_box_size<>( int size=, size:int=, int index=, index:int=, ):Vector2

Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).

 String get_name<>():String

Returns the name of the server interface.

 String get_support_data_filename<>():String

Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.

 String get_support_data_info<>():String

Returns TextServer database (e.g. ICU break iterators and dictionaries) description.

 bool has<>( RID rid=, rid:RID=, ):bool

Returns true if rid is valid resource owned by this text server.

 bool has_feature<>( Feature feature=, feature:Feature=, ):bool

Returns true if the server supports a feature.

 int is_confusable<>( String string=, string:String=, PackedStringArray dict=, dict:PackedStringArray=, ):int

Returns index of the first string in dict which is visually confusable with the string, or -1 if none is found.

Note: This method doesn't detect invisible characters, for spoof detection use it in combination with spoof_check.

Note: Always returns -1 if the server does not support the FEATURE_UNICODE_SECURITY feature.

 bool is_locale_right_to_left<>( String locale=, locale:String=, ):bool

Returns true if locale is right-to-left.

 bool is_valid_identifier<>( String string=, string:String=, ):bool

Returns true if string is a valid identifier.

If the text server supports the FEATURE_UNICODE_IDENTIFIERS feature, a valid identifier must:

  • Conform to normalization form C.

  • Begin with a Unicode character of class XID_Start or "_".

  • May contain Unicode characters of class XID_Continue in the other positions.

  • Use UAX #31 recommended scripts only (mixed scripts are allowed).

If the FEATURE_UNICODE_IDENTIFIERS feature is not supported, a valid identifier must:

  • Begin with a Unicode character of class XID_Start or "_".

  • May contain Unicode characters of class XID_Continue in the other positions.

 bool load_support_data<>( String filename=, filename:String=, ):bool

Loads optional TextServer database (e.g. ICU break iterators and dictionaries).

Note: This function should be called before any other TextServer functions used, otherwise it won't have any effect.

 int name_to_tag<>( String name=, name:String=, ):int

Converts readable feature, variation, script or language name to OpenType tag.

 String parse_number<>( String number=, number:String=, String language="", language:String="", ):String

Converts number from the numeral systems used in language to Western Arabic (0..9).

 Vector3i[] parse_structured_text<>( StructuredTextParser parser_type=, parser_type:StructuredTextParser=, Array args=, args:Array=, String text=, text:String=, ):Vector3i[]

Default implementation of the BiDi algorithm override function. See StructuredTextParser for more info.

 String percent_sign<>( String language="", language:String="", ):String

Returns percent sign used in the language.

 bool save_support_data<>( String filename=, filename:String=, ):bool

Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.

Note: This function is used by during project export, to include TextServer database.

 int shaped_get_span_count<>( RID shaped=, shaped:RID=, ):int

Returns number of text spans added using shaped_text_add_string or shaped_text_add_object.

 Variant shaped_get_span_meta<>( RID shaped=, shaped:RID=, int index=, index:int=, ):Variant

Returns text span metadata.

 void shaped_set_span_update_font<>( RID shaped=, shaped:RID=, int index=, index:int=, RID=, RID:=, int size=, size:int=, Dictionary=, Dictionary:=, ):void

Changes text span font, font size and OpenType features, without changing the text.

 bool shaped_text_add_object<>( RID shaped=, shaped:RID=, Variant key=, key:Variant=, Vector2 size=, size:Vector2=, InlineAlignment inline_align=5, inline_align:InlineAlignment=5, int length=1, length:int=1, float baseline=0.0, baseline:float=0.0, ):bool

Adds inline object to the text buffer, key must be unique. In the text, object is represented as length object replacement characters.

 bool shaped_text_add_string<>( RID shaped=, shaped:RID=, String text=, text:String=, RID=, RID:=, int size=, size:int=, Dictionary=, Dictionary:=, String language="", language:String="", Variant meta=null, meta:Variant=null, ):bool

Adds text span and font to draw it to the text buffer.

 void shaped_text_clear<>( RID rid=, rid:RID=, ):void

Clears text buffer (removes text and inline objects).

 int shaped_text_closest_character_pos<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):int

Returns composite character position closest to the pos.

 void shaped_text_draw<>( RID shaped=, shaped:RID=, RID canvas=, canvas:RID=, Vector2 pos=, pos:Vector2=, float=, float:=, float=, float:=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):void

Draw shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).

 void shaped_text_draw_outline<>( RID shaped=, shaped:RID=, RID canvas=, canvas:RID=, Vector2 pos=, pos:Vector2=, float=, float:=, float=, float:=, int outline_size=1, outline_size:int=1, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):void

Draw the outline of the shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).

 float shaped_text_fit_to_width<>( RID shaped=, shaped:RID=, float width=, width:float=, BitField=, BitField:=, ):float

Adjusts text width to fit to specified width, returns new text width.

 float shaped_text_get_ascent<>( RID shaped=, shaped:RID=, ):float

Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).

Note: Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.

 Dictionary shaped_text_get_carets<>( RID shaped=, shaped:RID=, int position=, position:int=, ):Dictionary

Returns shapes of the carets corresponding to the character offset position in the text. Returned caret shape is 1 pixel wide rectangle.

 PackedInt32Array shaped_text_get_character_breaks<>( RID shaped=, shaped:RID=, ):PackedInt32Array

Returns array of the composite character boundaries.

 int shaped_text_get_custom_ellipsis<>( RID shaped=, shaped:RID=, ):int

Returns ellipsis character used for text clipping.

 String shaped_text_get_custom_punctuation<>( RID shaped=, shaped:RID=, ):String

Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.

 float shaped_text_get_descent<>( RID shaped=, shaped:RID=, ):float

Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).

Note: Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.

 Direction shaped_text_get_direction<>( RID shaped=, shaped:RID=, ):Direction

Returns direction of the text.

 Direction shaped_text_get_dominant_direction_in_range<>( RID shaped=, shaped:RID=, int start=, start:int=, int end=, end:int=, ):Direction

Returns dominant direction of in the range of text.

 int shaped_text_get_ellipsis_glyph_count<>( RID shaped=, shaped:RID=, ):int

Returns number of glyphs in the ellipsis.

 Dictionary[] shaped_text_get_ellipsis_glyphs<>( RID shaped=, shaped:RID=, ):Dictionary[]

Returns array of the glyphs in the ellipsis.

 int shaped_text_get_ellipsis_pos<>( RID shaped=, shaped:RID=, ):int

Returns position of the ellipsis.

 int shaped_text_get_glyph_count<>( RID shaped=, shaped:RID=, ):int

Returns number of glyphs in the buffer.

 Dictionary[] shaped_text_get_glyphs<>( RID shaped=, shaped:RID=, ):Dictionary[]

Returns an array of glyphs in the visual order.

 Vector2 shaped_text_get_grapheme_bounds<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):Vector2

Returns composite character's bounds as offsets from the start of the line.

 Direction shaped_text_get_inferred_direction<>( RID shaped=, shaped:RID=, ):Direction

Returns direction of the text, inferred by the BiDi algorithm.

 PackedInt32Array shaped_text_get_line_breaks<>( RID shaped=, shaped:RID=, float width=, width:float=, int start=0, start:int=0, BitField=, BitField:=, ):PackedInt32Array

Breaks text to the lines and returns character ranges for each line.

 PackedInt32Array shaped_text_get_line_breaks_adv<>( RID shaped=, shaped:RID=, PackedFloat32Array width=, width:PackedFloat32Array=, int start=0, start:int=0, bool once=true, once:bool=true, BitField=, BitField:=, ):PackedInt32Array

Breaks text to the lines and columns. Returns character ranges for each segment.

 Rect2 shaped_text_get_object_rect<>( RID shaped=, shaped:RID=, Variant key=, key:Variant=, ):Rect2

Returns bounding rectangle of the inline object.

 Array shaped_text_get_objects<>( RID shaped=, shaped:RID=, ):Array

Returns array of inline objects.

 Orientation shaped_text_get_orientation<>( RID shaped=, shaped:RID=, ):Orientation

Returns text orientation.

 RID shaped_text_get_parent<>( RID shaped=, shaped:RID=, ):RID

Returns the parent buffer from which the substring originates.

 bool shaped_text_get_preserve_control<>( RID shaped=, shaped:RID=, ):bool

Returns true if text buffer is configured to display control characters.

 bool shaped_text_get_preserve_invalid<>( RID shaped=, shaped:RID=, ):bool

Returns true if text buffer is configured to display hexadecimal codes in place of invalid characters.

Note: If set to false, nothing is displayed in place of invalid characters.

 Vector2i shaped_text_get_range<>( RID shaped=, shaped:RID=, ):Vector2i

Returns substring buffer character range in the parent buffer.

 PackedVector2Array shaped_text_get_selection<>( RID shaped=, shaped:RID=, int start=, start:int=, int end=, end:int=, ):PackedVector2Array

Returns selection rectangles for the specified character range.

 Vector2 shaped_text_get_size<>( RID shaped=, shaped:RID=, ):Vector2

Returns size of the text.

 int shaped_text_get_spacing<>( RID shaped=, shaped:RID=, SpacingType spacing=, spacing:SpacingType=, ):int

Returns extra spacing added between glyphs or lines in pixels.

 int shaped_text_get_trim_pos<>( RID shaped=, shaped:RID=, ):int

Returns the position of the overrun trim.

 float shaped_text_get_underline_position<>( RID shaped=, shaped:RID=, ):float

Returns pixel offset of the underline below the baseline.

 float shaped_text_get_underline_thickness<>( RID shaped=, shaped:RID=, ):float

Returns thickness of the underline.

 float shaped_text_get_width<>( RID shaped=, shaped:RID=, ):float

Returns width (for horizontal layout) or height (for vertical) of the text.

 PackedInt32Array shaped_text_get_word_breaks<>( RID shaped=, shaped:RID=, BitField=, BitField:=, ):PackedInt32Array

Breaks text into words and returns array of character ranges. Use grapheme_flags to set what characters are used for breaking (see GraphemeFlag).

 bool shaped_text_has_visible_chars<>( RID shaped=, shaped:RID=, ):bool

Returns true if text buffer contains any visible characters.

 int shaped_text_hit_test_grapheme<>( RID shaped=, shaped:RID=, float coords=, coords:float=, ):int

Returns grapheme index at the specified pixel offset at the baseline, or -1 if none is found.

 int shaped_text_hit_test_position<>( RID shaped=, shaped:RID=, float coords=, coords:float=, ):int

Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.

 bool shaped_text_is_ready<>( RID shaped=, shaped:RID=, ):bool

Returns true if buffer is successfully shaped.

 int shaped_text_next_character_pos<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):int

Returns composite character end position closest to the pos.

 int shaped_text_next_grapheme_pos<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):int

Returns grapheme end position closest to the pos.

 void shaped_text_overrun_trim_to_width<>( RID shaped=, shaped:RID=, float width=0, width:float=0, BitField=, BitField:=, ):void

Trims text if it exceeds the given width.

 int shaped_text_prev_character_pos<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):int

Returns composite character start position closest to the pos.

 int shaped_text_prev_grapheme_pos<>( RID shaped=, shaped:RID=, int pos=, pos:int=, ):int

Returns grapheme start position closest to the pos.

 bool shaped_text_resize_object<>( RID shaped=, shaped:RID=, Variant key=, key:Variant=, Vector2 size=, size:Vector2=, InlineAlignment inline_align=5, inline_align:InlineAlignment=5, float baseline=0.0, baseline:float=0.0, ):bool

Sets new size and alignment of embedded object.

 void shaped_text_set_bidi_override<>( RID shaped=, shaped:RID=, Array override=, override:Array=, ):void

Overrides BiDi for the structured text.

Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.

 void shaped_text_set_custom_ellipsis<>( RID shaped=, shaped:RID=, int char=, char:int=, ):void

Sets ellipsis character used for text clipping.

 void shaped_text_set_custom_punctuation<>( RID shaped=, shaped:RID=, String punct=, punct:String=, ):void

Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.

 void shaped_text_set_direction<>( RID shaped=, shaped:RID=, Direction direction=0, direction:Direction=0, ):void

Sets desired text direction. If set to DIRECTION_AUTO, direction will be detected based on the buffer contents and current locale.

Note: Direction is ignored if server does not support FEATURE_BIDI_LAYOUT feature (supported by TextServerAdvanced).

 void shaped_text_set_orientation<>( RID shaped=, shaped:RID=, Orientation orientation=0, orientation:Orientation=0, ):void

Sets desired text orientation.

Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextServerAdvanced).

 void shaped_text_set_preserve_control<>( RID shaped=, shaped:RID=, bool enabled=, enabled:bool=, ):void

If set to true text buffer will display control characters.

 void shaped_text_set_preserve_invalid<>( RID shaped=, shaped:RID=, bool enabled=, enabled:bool=, ):void

If set to true text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.

 void shaped_text_set_spacing<>( RID shaped=, shaped:RID=, SpacingType spacing=, spacing:SpacingType=, int value=, value:int=, ):void

Sets extra spacing added between glyphs or lines in pixels.

 bool shaped_text_shape<>( RID shaped=, shaped:RID=, ):bool

Shapes buffer if it's not shaped. Returns true if the string is shaped successfully.

Note: It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested.

 Dictionary[] shaped_text_sort_logical<>( RID shaped=, shaped:RID=, ):Dictionary[]

Returns text glyphs in the logical order.

 RID shaped_text_substr<>( RID shaped=, shaped:RID=, int start=, start:int=, int length=, length:int=, ):RID

Returns text buffer for the substring of the text in the shaped text buffer (including inline objects).

 float shaped_text_tab_align<>( RID shaped=, shaped:RID=, PackedFloat32Array tab_stops=, tab_stops:PackedFloat32Array=, ):float

Aligns shaped text to the given tab-stops.

 bool spoof_check<>( String string=, string:String=, ):bool

Returns true if string is likely to be an attempt at confusing the reader.

Note: Always returns false if the server does not support the FEATURE_UNICODE_SECURITY feature.

 PackedInt32Array string_get_character_breaks<>( String string=, string:String=, String language="", language:String="", ):PackedInt32Array

Returns array of the composite character boundaries.
var ts = TextServerManager.get_primary_interface() print(ts.string_get_word_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
PackedInt32Array string_get_word_breaks<>( String string=, string:String=, String language="", language:String="", int chars_per_line=0, chars_per_line:int=0, ):PackedInt32Array

Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even.

When chars_per_line is greater than zero, line break boundaries are returned instead.

var ts = TextServerManager.get_primary_interface() print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12] print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
String string_to_lower<>( String string=, string:String=, String language="", language:String="", ):String

Returns the string converted to lowercase.

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 string_to_upper<>( String string=, string:String=, String language="", language:String="", ):String

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=, string:String=, ):String

Strips diacritics from the string.

Note: The result may be longer or shorter than the original.

 String tag_to_name<>( int tag=, tag:int=, ):String

Converts OpenType tag to readable feature, variation, script or language name.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...