Base class for custom [TextServer] implementations (plugins).
External [TextServer] implementations should inherit from this class.
[b]Optional.[/b] This method is called before text server is unregistered.
[b]Required.[/b] Creates a new, empty font cache entry resource.
Optional, implement if font supports extra spacing or baseline offset. Creates a new variation existing font which is reusing the same glyph cache and font data.
[b]Required.[/b] Creates a new buffer for complex text layout, with the given [param direction] and [param orientation].
[b]Optional.[/b] Draws box displaying character hexadecimal code.
[b]Required.[/b] Removes all rendered glyph information from the cache entry.
[b]Optional.[/b] Removes all kerning overrides.
[b]Required.[/b] Removes all font sizes from the cache entry.
[b]Required.[/b] Removes all textures from font cache entry.
[b]Required.[/b] Draws single glyph into a canvas item at the position, using [param font_rid] at the size [param size].
[b]Required.[/b] Draws single glyph outline of size [param outline_size] into a canvas item at the position, using [param font_rid] at the size [param size].
[b]Optional.[/b] Returns font anti-aliasing mode.
[b]Required.[/b] Returns the font ascent (number of pixels above the baseline).
[b]Optional.[/b] Returns extra baseline offset (as a fraction of font height).
[b]Required.[/b] Returns character code associated with [param glyph_index], or [code]0[/code] if [param glyph_index] is invalid.
[b]Required.[/b] Returns the font descent (number of pixels below the baseline).
[b]Optional.[/b] Returns whether the font's embedded bitmap loading is disabled.
[b]Optional.[/b] Returns font embolden strength.
[b]Optional.[/b] Returns number of faces in the TrueType / OpenType collection.
[b]Optional.[/b] Returns an active face index in the TrueType / OpenType collection.
[b]Required.[/b] Returns bitmap font fixed size.
[b]Required.[/b] Returns bitmap font scaling mode.
[b]Optional.[/b] Returns [code]true[/code] if font texture mipmap generation is enabled.
[b]Optional.[/b] Returns the font oversampling factor, shared by all fonts in the TextServer.
[b]Required.[/b] Returns glyph advance (offset of the next glyph).
[b]Optional.[/b] Returns outline contours of the glyph.
[b]Required.[/b] Returns the glyph index of a [param char], optionally modified by the [param variation_selector].
[b]Required.[/b] Returns list of rendered glyphs in the cache entry.
[b]Required.[/b] Returns glyph offset from the baseline.
[b]Required.[/b] Returns size of the glyph.
[b]Required.[/b] Returns index of the cache texture containing the glyph.
[b]Required.[/b] Returns resource ID of the cache texture containing the glyph.
[b]Required.[/b] Returns size of the cache texture containing the glyph.
[b]Required.[/b] Returns rectangle in the cache texture containing the glyph.
[b]Optional.[/b] Returns the font hinting mode. Used by dynamic fonts only.
[b]Optional.[/b] Returns kerning for the pair of glyphs.
[b]Optional.[/b] Returns list of the kerning overrides.
[b]Optional.[/b] Returns [code]true[/code] if support override is enabled for the [param language].
[b]Optional.[/b] Returns list of language support overrides.
[b]Optional.[/b] Returns the width of the range around the shape between the minimum and maximum representable signed distance.
[b]Optional.[/b] Returns source font size used to generate MSDF textures.
[b]Optional.[/b] Returns font family name.
[b]Optional.[/b] Returns font OpenType feature set override.
[b]Optional.[/b] Returns [Dictionary] with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
[b]Optional.[/b] Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only.
[b]Required.[/b] Returns scaling factor of the color bitmap font.
[b]Optional.[/b] Returns [code]true[/code] if support override is enabled for the [param script].
[b]Optional.[/b] Returns list of script support overrides.
[b]Required.[/b] Returns list of the font sizes in the cache. Each size is [Vector2i] with font size and outline size.
[b]Optional.[/b] Returns the spacing for [param spacing] (see [enum TextServer.SpacingType]) in pixels (not relative to the font size).
[b]Optional.[/b] Returns font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code].
[b]Optional.[/b] Returns font style flags, see [enum TextServer.FontStyle].
[b]Optional.[/b] Returns font style name.
[b]Optional.[/b] Returns font subpixel glyph positioning mode.
[b]Required.[/b] Returns a string containing all the characters available in the font.
[b]Required.[/b] Returns number of textures used by font cache entry.
[b]Required.[/b] Returns font cache texture image data.
[b]Optional.[/b] Returns array containing glyph packing data.
[b]Optional.[/b] Returns 2D transform applied to the font outlines.
[b]Required.[/b] Returns pixel offset of the underline below the baseline.
[b]Required.[/b] Returns thickness of the underline in pixels.
[b]Optional.[/b] Returns variation coordinates for the specified font cache entry.
[b]Optional.[/b] Returns weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code].
[b]Required.[/b] Returns [code]true[/code] if a Unicode [param char] is available in the font.
[b]Optional.[/b] Returns [code]true[/code] if system fonts can be automatically used as fallbacks.
[b]Optional.[/b] Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting.
[b]Optional.[/b] Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code).
[b]Optional.[/b] Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
[b]Optional.[/b] Returns [code]true[/code], if font supports given script (ISO 15924 code).
[b]Required.[/b] Removes specified rendered glyph information from the cache entry.
[b]Optional.[/b] Removes kerning override for the pair of glyphs.
[b]Optional.[/b] Remove language support override.
[b]Optional.[/b] Removes script support override.
[b]Required.[/b] Removes specified font size from the cache entry.
[b]Required.[/b] Removes specified texture from the cache entry.
[b]Optional.[/b] Renders specified glyph to the font cache texture.
[b]Optional.[/b] Renders the range of characters to the font cache texture.
[b]Optional.[/b] If set to [code]true[/code], system fonts can be automatically used as fallbacks.
[b]Optional.[/b] Sets font anti-aliasing mode.
[b]Required.[/b] Sets the font ascent (number of pixels above the baseline).
[b]Optional.[/b] Sets extra baseline offset (as a fraction of font height).
[b]Optional.[/b] Sets font source data, e.g contents of the dynamic font source file.
[b]Optional.[/b] Sets pointer to the font source data, e.g contents of the dynamic font source file.
[b]Required.[/b] Sets the font descent (number of pixels below the baseline).
[b]Optional.[/b] If set to [code]true[/code], embedded font bitmap loading is disabled.
Sets font embolden strength. If [param strength] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
[b]Optional.[/b] Sets an active face index in the TrueType / OpenType collection.
[b]Required.[/b] Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
[b]Required.[/b] Sets bitmap font scaling mode. This property is used only if [code]fixed_size[/code] is greater than zero.
[b]Optional.[/b] If set to [code]true[/code] auto-hinting is preferred over font built-in hinting.
[b]Optional.[/b] If set to [code]true[/code] font texture mipmap generation is enabled.
[b]Optional.[/b] Sets oversampling factor, shared by all font in the TextServer.
[b]Required.[/b] Sets glyph advance (offset of the next glyph).
[b]Required.[/b] Sets glyph offset from the baseline.
[b]Required.[/b] Sets size of the glyph.
[b]Required.[/b] Sets index of the cache texture containing the glyph.
[b]Required.[/b] Sets rectangle in the cache texture containing the glyph.
[b]Optional.[/b] Sets font hinting mode. Used by dynamic fonts only.
[b]Optional.[/b] Sets kerning for the pair of glyphs.
[b]Optional.[/b] Adds override for [method _font_is_language_supported].
[b]Optional.[/b] Sets the width of the range around the shape between the minimum and maximum representable signed distance.
[b]Optional.[/b] Sets source font size used to generate MSDF textures.
[b]Optional.[/b] If set to [code]true[/code], 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.
[b]Optional.[/b] Sets the font family name.
[b]Optional.[/b] Sets font OpenType feature set override.
[b]Optional.[/b] Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only.
[b]Required.[/b] Sets scaling factor of the color bitmap font.
[b]Optional.[/b] Adds override for [method _font_is_script_supported].
[b]Optional.[/b] Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size).
[b]Optional.[/b] Sets font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code].
[b]Optional.[/b] Sets the font style flags, see [enum TextServer.FontStyle].
[b]Optional.[/b] Sets the font style name.
[b]Optional.[/b] Sets font subpixel glyph positioning mode.
[b]Required.[/b] Sets font cache texture image data.
[b]Optional.[/b] Sets array containing glyph packing data.
[b]Optional.[/b] Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
[b]Required.[/b] Sets pixel offset of the underline below the baseline.
[b]Required.[/b] Sets thickness of the underline in pixels.
[b]Optional.[/b] Sets variation coordinates for the specified font cache entry.
[b]Optional.[/b] Sets weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code].
[b]Optional.[/b] Returns the dictionary of the supported OpenType features.
[b]Optional.[/b] Returns the dictionary of the supported OpenType variation coordinates.
[b]Optional.[/b] Converts a number from the Western Arabic (0..9) to the numeral systems used in [param language].
[b]Required.[/b] Frees an object created by this [TextServer].
[b]Required.[/b] Returns text server features, see [enum TextServer.Feature].
[b]Optional.[/b] Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
[b]Required.[/b] Returns the name of the server interface.
[b]Optional.[/b] Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
[b]Optional.[/b] Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
[b]Required.[/b] Returns [code]true[/code] if [param rid] is valid resource owned by this text server.
[b]Required.[/b] Returns [code]true[/code] if the server supports a feature.
[b]Optional.[/b] Returns index of the first string in [param dict] which is visually confusable with the [param string], or [code]-1[/code] if none is found.
[b]Required.[/b] Returns [code]true[/code] if locale is right-to-left.
[b]Optional.[/b] Returns [code]true[/code] if [param string] is a valid identifier.
[b]Optional.[/b] Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
[b]Optional.[/b] Converts readable feature, variation, script, or language name to OpenType tag.
[b]Optional.[/b] Converts [param number] from the numeral systems used in [param language] to Western Arabic (0..9).
[b]Optional.[/b] Default implementation of the BiDi algorithm override function. See [enum TextServer.StructuredTextParser] for more info.
[b]Optional.[/b] Returns percent sign used in the [param language].
[b]Optional.[/b] Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
[b]Required.[/b] Returns number of text spans added using [method _shaped_text_add_string] or [method _shaped_text_add_object].
[b]Required.[/b] Returns text span metadata.
[b]Required.[/b] Changes text span font, font size, and OpenType features, without changing the text.
[b]Required.[/b] Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters.
[b]Required.[/b] Adds text span and font to draw it to the text buffer.
[b]Required.[/b] Clears text buffer (removes text and inline objects).
[b]Optional.[/b] Returns composite character position closest to the [param pos].
[b]Optional.[/b] Draw shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
[b]Optional.[/b] Draw the outline of the shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
[b]Optional.[/b] Adjusts text width to fit to specified width, returns new text width.
[b]Required.[/b] Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
[b]Optional.[/b] Returns shapes of the carets corresponding to the character offset [param position] in the text. Returned caret shape is 1 pixel wide rectangle.
[b]Optional.[/b] Returns array of the composite character boundaries.
[b]Optional.[/b] Returns ellipsis character used for text clipping.
[b]Optional.[/b] Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
[b]Required.[/b] Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
[b]Optional.[/b] Returns direction of the text.
[b]Optional.[/b] Returns dominant direction of in the range of text.
[b]Required.[/b] Returns number of glyphs in the ellipsis.
[b]Required.[/b] Returns array of the glyphs in the ellipsis.
[b]Required.[/b] Returns position of the ellipsis.
[b]Required.[/b] Returns number of glyphs in the buffer.
[b]Required.[/b] Returns an array of glyphs in the visual order.
[b]Optional.[/b] Returns composite character's bounds as offsets from the start of the line.
[b]Optional.[/b] Returns direction of the text, inferred by the BiDi algorithm.
[b]Optional.[/b] Breaks text to the lines and returns character ranges for each line.
[b]Optional.[/b] Breaks text to the lines and columns. Returns character ranges for each segment.
[b]Required.[/b] Returns the glyph index of the inline object.
[b]Required.[/b] Returns the character range of the inline object.
[b]Required.[/b] Returns bounding rectangle of the inline object.
[b]Required.[/b] Returns array of inline objects.
[b]Optional.[/b] Returns text orientation.
[b]Required.[/b] Returns the parent buffer from which the substring originates.
[b]Optional.[/b] Returns [code]true[/code] if text buffer is configured to display control characters.
[b]Optional.[/b] Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters.
[b]Required.[/b] Returns substring buffer character range in the parent buffer.
[b]Optional.[/b] Returns selection rectangles for the specified character range.
[b]Required.[/b] Returns size of the text.
[b]Optional.[/b] Returns extra spacing added between glyphs or lines in pixels.
[b]Required.[/b] Returns the position of the overrun trim.
[b]Required.[/b] Returns pixel offset of the underline below the baseline.
[b]Required.[/b] Returns thickness of the underline.
[b]Required.[/b] Returns width (for horizontal layout) or height (for vertical) of the text.
[b]Optional.[/b] Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking (see [enum TextServer.GraphemeFlag]).
[b]Optional.[/b] Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found.
[b]Optional.[/b] Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
[b]Required.[/b] Returns [code]true[/code] if buffer is successfully shaped.
[b]Optional.[/b] Returns composite character end position closest to the [param pos].
[b]Optional.[/b] Returns grapheme end position closest to the [param pos].
[b]Optional.[/b] Trims text if it exceeds the given width.
[b]Optional.[/b] Returns composite character start position closest to the [param pos].
[b]Optional.[/b] Returns grapheme start position closest to the [param pos].
[b]Required.[/b] Sets new size and alignment of embedded object.
[b]Optional.[/b] Overrides BiDi for the structured text.
[b]Optional.[/b] Sets ellipsis character used for text clipping.
[b]Optional.[/b] Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
[b]Optional.[/b] Sets desired text direction. If set to [constant TextServer.DIRECTION_AUTO], direction will be detected based on the buffer contents and current locale.
[b]Optional.[/b] Sets desired text orientation.
[b]Optional.[/b] If set to [code]true[/code] text buffer will display control characters.
[b]Optional.[/b] If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
[b]Optional.[/b] Sets extra spacing added between glyphs or lines in pixels.
[b]Required.[/b] Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully.
[b]Required.[/b] Returns text glyphs in the logical order.
[b]Required.[/b] Returns text buffer for the substring of the text in the [param shaped] text buffer (including inline objects).
[b]Optional.[/b] Aligns shaped text to the given tab-stops.
[b]Optional.[/b] Updates break points in the shaped text. This method is called by default implementation of text breaking functions.
[b]Optional.[/b] Updates justification points in the shaped text. This method is called by default implementation of text justification functions.
[b]Optional.[/b] Returns [code]true[/code] if [param string] is likely to be an attempt at confusing the reader.
[b]Optional.[/b] Returns array of the composite character boundaries.
[b]Optional.[/b] 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.
[b]Optional.[/b] Returns the string converted to lowercase.
[b]Optional.[/b] Returns the string converted to title case.
[b]Optional.[/b] Returns the string converted to uppercase.
[b]Optional.[/b] Strips diacritics from the string.
[b]Optional.[/b] Converts OpenType tag to readable feature, variation, script, or language name.