Inheritance #

Object
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
RefCounted
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
TextServer
- TextServerExtension (2)
TextServerExtension
- TextServerAdvanced
- TextServerDummy
Table of contents

TextServerExtension #

is_refcounted, is_instantiable, core, not_builtin_classes

Base class for custom TextServer implementations (plugins).

External TextServer implementations should inherit from this class.

Members #

Methods #

virtual func _cleanup() -> void#

Optional.

This method is called before text server is unregistered.

virtual func _create_font() -> RID#

Required.

Creates a new, empty font cache entry resource.

virtual func _create_font_linked_variation(font_rid: RID) -> RID#

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.

virtual func _create_shaped_text(orientation: int enumTextServer.Orientation) -> RID#

Required.

Creates a new buffer for complex text layout, with the given direction and orientation.

virtual const func _draw_hex_code_box(color: Color) -> void#

Optional.

Draws box displaying character hexadecimal code.

virtual func _font_clear_glyphs(size: Vector2i) -> void#

Required.

Removes all rendered glyph information from the cache entry.

virtual func _font_clear_kerning_map(size: int) -> void#

Optional.

Removes all kerning overrides.

virtual func _font_clear_size_cache(font_rid: RID) -> void#

Required.

Removes all font sizes from the cache entry.

virtual func _font_clear_textures(size: Vector2i) -> void#

Required.

Removes all textures from font cache entry.

virtual const func _font_draw_glyph(color: Color) -> void#

Required.

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

virtual const func _font_draw_glyph_outline(color: Color) -> void#

Required.

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

virtual const func _font_get_antialiasing(font_rid: RID) -> intTextServer.FontAntialiasing#

Optional.

Returns font anti-aliasing mode.

virtual const func _font_get_ascent(size: int) -> float#

Required.

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

virtual const func _font_get_baseline_offset(font_rid: RID) -> float#

Optional.

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

virtual const func _font_get_char_from_glyph_index(glyph_index: int) -> int#

Required.

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

virtual const func _font_get_descent(size: int) -> float#

Required.

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

virtual const func _font_get_disable_embedded_bitmaps(font_rid: RID) -> bool#

Optional.

Returns whether the font's embedded bitmap loading is disabled.

virtual const func _font_get_embolden(font_rid: RID) -> float#

Optional.

Returns font embolden strength.

virtual const func _font_get_face_count(font_rid: RID) -> int#

Optional.

Returns number of faces in the TrueType / OpenType collection.

virtual const func _font_get_face_index(font_rid: RID) -> int#

Optional.

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

virtual const func _font_get_fixed_size(font_rid: RID) -> int#

Required.

Returns bitmap font fixed size.

virtual const func _font_get_fixed_size_scale_mode(font_rid: RID) -> intTextServer.FixedSizeScaleMode#

Required.

Returns bitmap font scaling mode.

virtual const func _font_get_generate_mipmaps(font_rid: RID) -> bool#

Optional.

Returns true if font texture mipmap generation is enabled.

virtual const func _font_get_global_oversampling() -> float#

Optional.

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

virtual const func _font_get_glyph_advance(glyph: int) -> Vector2#

Required.

Returns glyph advance (offset of the next glyph).

virtual const func _font_get_glyph_contours(index: int) -> Dictionary#

Optional.

Returns outline contours of the glyph.

virtual const func _font_get_glyph_index(variation_selector: int) -> int#

Required.

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

virtual const func _font_get_glyph_list(size: Vector2i) -> PackedInt32Array#

Required.

Returns list of rendered glyphs in the cache entry.

virtual const func _font_get_glyph_offset(glyph: int) -> Vector2#

Required.

Returns glyph offset from the baseline.

virtual const func _font_get_glyph_size(glyph: int) -> Vector2#

Required.

Returns size of the glyph.

virtual const func _font_get_glyph_texture_idx(glyph: int) -> int#

Required.

Returns index of the cache texture containing the glyph.

virtual const func _font_get_glyph_texture_rid(glyph: int) -> RID#

Required.

Returns resource ID of the cache texture containing the glyph.

virtual const func _font_get_glyph_texture_size(glyph: int) -> Vector2#

Required.

Returns size of the cache texture containing the glyph.

virtual const func _font_get_glyph_uv_rect(glyph: int) -> Rect2#

Required.

Returns rectangle in the cache texture containing the glyph.

virtual const func _font_get_hinting(font_rid: RID) -> intTextServer.Hinting#

Optional.

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

virtual const func _font_get_keep_rounding_remainders(font_rid: RID) -> bool#

Optional.

Returns glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

virtual const func _font_get_kerning(glyph_pair: Vector2i) -> Vector2#

Optional.

Returns kerning for the pair of glyphs.

virtual const func _font_get_kerning_list(size: int) -> Vector2i[]#

Optional.

Returns list of the kerning overrides.

virtual func _font_get_language_support_override(language: String) -> bool#

Optional.

Returns true if support override is enabled for the language.

virtual func _font_get_language_support_overrides(font_rid: RID) -> PackedStringArray#

Optional.

Returns list of language support overrides.

virtual const func _font_get_msdf_pixel_range(font_rid: RID) -> int#

Optional.

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

virtual const func _font_get_msdf_size(font_rid: RID) -> int#

Optional.

Returns source font size used to generate MSDF textures.

virtual const func _font_get_name(font_rid: RID) -> String#

Optional.

Returns font family name.

virtual const func _font_get_opentype_feature_overrides(font_rid: RID) -> Dictionary#

Optional.

Returns font OpenType feature set override.

virtual const func _font_get_ot_name_strings(font_rid: RID) -> Dictionary#

Optional.

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

virtual const func _font_get_oversampling(font_rid: RID) -> float#

Optional.

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

virtual const func _font_get_scale(size: int) -> float#

Required.

Returns scaling factor of the color bitmap font.

virtual func _font_get_script_support_override(script: String) -> bool#

Optional.

Returns true if support override is enabled for the script.

virtual func _font_get_script_support_overrides(font_rid: RID) -> PackedStringArray#

Optional.

Returns list of script support overrides.

virtual const func _font_get_size_cache_list(font_rid: RID) -> Vector2i[]#

Required.

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

virtual const func _font_get_spacing(spacing: int enumTextServer.SpacingType) -> int#

Optional.

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

virtual const func _font_get_stretch(font_rid: RID) -> int#

Optional.

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

virtual const func _font_get_style(font_rid: RID) -> intTextServer.FontStyle#

Optional.

Returns font style flags, see TextServer.FontStyle.

virtual const func _font_get_style_name(font_rid: RID) -> String#

Optional.

Returns font style name.

virtual const func _font_get_subpixel_positioning(font_rid: RID) -> intTextServer.SubpixelPositioning#

Optional.

Returns font subpixel glyph positioning mode.

virtual const func _font_get_supported_chars(font_rid: RID) -> String#

Required.

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

virtual const func _font_get_supported_glyphs(font_rid: RID) -> PackedInt32Array#

Required.

Returns an array containing all glyph indices in the font.

virtual const func _font_get_texture_count(size: Vector2i) -> int#

Required.

Returns number of textures used by font cache entry.

virtual const func _font_get_texture_image(texture_index: int) -> Image#

Required.

Returns font cache texture image data.

virtual const func _font_get_texture_offsets(texture_index: int) -> PackedInt32Array#

Optional.

Returns array containing glyph packing data.

virtual const func _font_get_transform(font_rid: RID) -> Transform2D#

Optional.

Returns 2D transform applied to the font outlines.

virtual const func _font_get_underline_position(size: int) -> float#

Required.

Returns pixel offset of the underline below the baseline.

virtual const func _font_get_underline_thickness(size: int) -> float#

Required.

Returns thickness of the underline in pixels.

virtual const func _font_get_variation_coordinates(font_rid: RID) -> Dictionary#

Optional.

Returns variation coordinates for the specified font cache entry.

virtual const func _font_get_weight(font_rid: RID) -> int#

Optional.

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

virtual const func _font_has_char(char: int) -> bool#

Required.

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

virtual const func _font_is_allow_system_fallback(font_rid: RID) -> bool#

Optional.

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

virtual const func _font_is_force_autohinter(font_rid: RID) -> bool#

Optional.

Returns true if auto-hinting is supported and preferred over font built-in hinting.

virtual const func _font_is_language_supported(language: String) -> bool#

Optional.

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

virtual const func _font_is_multichannel_signed_distance_field(font_rid: RID) -> bool#

Optional.

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

virtual const func _font_is_script_supported(script: String) -> bool#

Optional.

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

virtual func _font_remove_glyph(glyph: int) -> void#

Required.

Removes specified rendered glyph information from the cache entry.

virtual func _font_remove_kerning(glyph_pair: Vector2i) -> void#

Optional.

Removes kerning override for the pair of glyphs.

virtual func _font_remove_language_support_override(language: String) -> void#

Optional.

Remove language support override.

virtual func _font_remove_script_support_override(script: String) -> void#

Optional.

Removes script support override.

virtual func _font_remove_size_cache(size: Vector2i) -> void#

Required.

Removes specified font size from the cache entry.

virtual func _font_remove_texture(texture_index: int) -> void#

Required.

Removes specified texture from the cache entry.

virtual func _font_render_glyph(index: int) -> void#

Optional.

Renders specified glyph to the font cache texture.

virtual func _font_render_range(end: int) -> void#

Optional.

Renders the range of characters to the font cache texture.

virtual func _font_set_allow_system_fallback(allow_system_fallback: bool) -> void#

Optional.

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

virtual func _font_set_antialiasing(antialiasing: int enumTextServer.FontAntialiasing) -> void#

Optional.

Sets font anti-aliasing mode.

virtual func _font_set_ascent(ascent: float) -> void#

Required.

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

virtual func _font_set_baseline_offset(baseline_offset: float) -> void#

Optional.

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

virtual func _font_set_data(data: PackedByteArray) -> void#

Optional.

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

virtual func _font_set_data_ptr(data_size: int) -> void#

Optional.

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

virtual func _font_set_descent(descent: float) -> void#

Required.

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

virtual func _font_set_disable_embedded_bitmaps(disable_embedded_bitmaps: bool) -> void#

Optional.

If set to true, embedded font bitmap loading is disabled.

virtual func _font_set_embolden(strength: float) -> void#

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

virtual func _font_set_face_index(face_index: int) -> void#

Optional.

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

virtual func _font_set_fixed_size(fixed_size: int) -> void#

Required.

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

virtual func _font_set_fixed_size_scale_mode(fixed_size_scale_mode: int enumTextServer.FixedSizeScaleMode) -> void#

Required.

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

virtual func _font_set_force_autohinter(force_autohinter: bool) -> void#

Optional.

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

virtual func _font_set_generate_mipmaps(generate_mipmaps: bool) -> void#

Optional.

If set to true font texture mipmap generation is enabled.

virtual func _font_set_global_oversampling(oversampling: float) -> void#

Optional.

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

virtual func _font_set_glyph_advance(advance: Vector2) -> void#

Required.

Sets glyph advance (offset of the next glyph).

virtual func _font_set_glyph_offset(offset: Vector2) -> void#

Required.

Sets glyph offset from the baseline.

virtual func _font_set_glyph_size(gl_size: Vector2) -> void#

Required.

Sets size of the glyph.

virtual func _font_set_glyph_texture_idx(texture_idx: int) -> void#

Required.

Sets index of the cache texture containing the glyph.

virtual func _font_set_glyph_uv_rect(uv_rect: Rect2) -> void#

Required.

Sets rectangle in the cache texture containing the glyph.

virtual func _font_set_hinting(hinting: int enumTextServer.Hinting) -> void#

Optional.

Sets font hinting mode. Used by dynamic fonts only.

virtual func _font_set_keep_rounding_remainders(keep_rounding_remainders: bool) -> void#

Optional.

Sets glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

virtual func _font_set_kerning(kerning: Vector2) -> void#

Optional.

Sets kerning for the pair of glyphs.

virtual func _font_set_language_support_override(supported: bool) -> void#

Optional.

Adds override for _font_is_language_supported.

virtual func _font_set_msdf_pixel_range(msdf_pixel_range: int) -> void#

Optional.

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

virtual func _font_set_msdf_size(msdf_size: int) -> void#

Optional.

Sets source font size used to generate MSDF textures.

virtual func _font_set_multichannel_signed_distance_field(msdf: bool) -> void#

Optional.

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.

virtual func _font_set_name(name: String) -> void#

Optional.

Sets the font family name.

virtual func _font_set_opentype_feature_overrides(overrides: Dictionary) -> void#

Optional.

Sets font OpenType feature set override.

virtual func _font_set_oversampling(oversampling: float) -> void#

Optional.

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

virtual func _font_set_scale(scale: float) -> void#

Required.

Sets scaling factor of the color bitmap font.

virtual func _font_set_script_support_override(supported: bool) -> void#

Optional.

Adds override for _font_is_script_supported.

virtual func _font_set_spacing(value: int) -> void#

Optional.

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

virtual func _font_set_stretch(stretch: int) -> void#

Optional.

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

virtual func _font_set_style(style: int enumTextServer.FontStyle) -> void#

Optional.

Sets the font style flags, see TextServer.FontStyle.

virtual func _font_set_style_name(name_style: String) -> void#

Optional.

Sets the font style name.

virtual func _font_set_subpixel_positioning(subpixel_positioning: int enumTextServer.SubpixelPositioning) -> void#

Optional.

Sets font subpixel glyph positioning mode.

virtual func _font_set_texture_image(image: Image) -> void#

Required.

Sets font cache texture image data.

virtual func _font_set_texture_offsets(offset: PackedInt32Array) -> void#

Optional.

Sets array containing glyph packing data.

virtual func _font_set_transform(transform: Transform2D) -> void#

Optional.

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

virtual func _font_set_underline_position(underline_position: float) -> void#

Required.

Sets pixel offset of the underline below the baseline.

virtual func _font_set_underline_thickness(underline_thickness: float) -> void#

Required.

Sets thickness of the underline in pixels.

virtual func _font_set_variation_coordinates(variation_coordinates: Dictionary) -> void#

Optional.

Sets variation coordinates for the specified font cache entry.

virtual func _font_set_weight(weight: int) -> void#

Optional.

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

virtual const func _font_supported_feature_list(font_rid: RID) -> Dictionary#

Optional.

Returns the dictionary of the supported OpenType features.

virtual const func _font_supported_variation_list(font_rid: RID) -> Dictionary#

Optional.

Returns the dictionary of the supported OpenType variation coordinates.

virtual const func _format_number(language: String) -> String#

Optional.

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

virtual func _free_rid(rid: RID) -> void#

Required.

Frees an object created by this TextServer.

virtual const func _get_features() -> int#

Required.

Returns text server features, see TextServer.Feature.

virtual const func _get_hex_code_box_size(index: int) -> Vector2#

Optional.

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

virtual const func _get_name() -> String#

Required.

Returns the name of the server interface.

virtual const func _get_support_data() -> PackedByteArray#

Optional.

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

virtual const func _get_support_data_filename() -> String#

Optional.

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

virtual const func _get_support_data_info() -> String#

Optional.

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

virtual func _has(rid: RID) -> bool#

Required.

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

virtual const func _has_feature(feature: int enumTextServer.Feature) -> bool#

Required.

Returns true if the server supports a feature.

virtual const func _is_confusable(dict: PackedStringArray) -> int#

Optional.

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

virtual const func _is_locale_right_to_left(locale: String) -> bool#

Required.

Returns true if locale is right-to-left.

virtual const func _is_valid_identifier(string: String) -> bool#

Optional.

Returns true if string is a valid identifier.

virtual const func _is_valid_letter(unicode: int) -> bool#

virtual func _load_support_data(filename: String) -> bool#

Optional.

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

virtual const func _name_to_tag(name: String) -> int#

Optional.

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

virtual const func _parse_number(language: String) -> String#

Optional.

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

virtual const func _parse_structured_text(text: String) -> Vector3i[]#

Optional.

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

virtual const func _percent_sign(language: String) -> String#

Optional.

Returns percent sign used in the language.

virtual const func _save_support_data(filename: String) -> bool#

Optional.

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

virtual const func _shaped_get_span_count(shaped: RID) -> int#

Required.

Returns number of text spans added using _shaped_text_add_string or _shaped_text_add_object.

virtual const func _shaped_get_span_embedded_object(index: int) -> Variant#

Required.

Returns text embedded object key.

virtual const func _shaped_get_span_meta(index: int) -> Variant#

Required.

Returns text span metadata.

virtual func _shaped_set_span_update_font(opentype_features: Dictionary) -> void#

Required.

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

virtual func _shaped_text_add_object(baseline: float) -> bool#

Required.

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

virtual func _shaped_text_add_string(meta: Variant) -> bool#

Required.

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

virtual func _shaped_text_clear(shaped: RID) -> void#

Required.

Clears text buffer (removes text and inline objects).

virtual const func _shaped_text_closest_character_pos(pos: int) -> int#

Optional.

Returns composite character position closest to the pos.

virtual const func _shaped_text_draw(color: Color) -> void#

Optional.

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

virtual const func _shaped_text_draw_outline(color: Color) -> void#

Optional.

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

virtual func _shaped_text_fit_to_width(justification_flags: int enumTextServer.JustificationFlag) -> float#

Optional.

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

virtual const func _shaped_text_get_ascent(shaped: RID) -> float#

Required.

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

virtual const func _shaped_text_get_carets(caret: CaretInfo*) -> void#

Optional.

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

virtual const func _shaped_text_get_character_breaks(shaped: RID) -> PackedInt32Array#

Optional.

Returns array of the composite character boundaries.

virtual const func _shaped_text_get_custom_ellipsis(shaped: RID) -> int#

Optional.

Returns ellipsis character used for text clipping.

virtual const func _shaped_text_get_custom_punctuation(shaped: RID) -> String#

Optional.

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

virtual const func _shaped_text_get_descent(shaped: RID) -> float#

Required.

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

virtual const func _shaped_text_get_direction(shaped: RID) -> intTextServer.Direction#

Optional.

Returns direction of the text.

virtual const func _shaped_text_get_dominant_direction_in_range(end: int) -> int#

Optional.

Returns dominant direction of in the range of text.

virtual const func _shaped_text_get_ellipsis_glyph_count(shaped: RID) -> int#

Required.

Returns number of glyphs in the ellipsis.

virtual const func _shaped_text_get_ellipsis_glyphs(shaped: RID) -> const Glyph*#

Required.

Returns array of the glyphs in the ellipsis.

virtual const func _shaped_text_get_ellipsis_pos(shaped: RID) -> int#

Required.

Returns position of the ellipsis.

virtual const func _shaped_text_get_glyph_count(shaped: RID) -> int#

Required.

Returns number of glyphs in the buffer.

virtual const func _shaped_text_get_glyphs(shaped: RID) -> const Glyph*#

Required.

Returns an array of glyphs in the visual order.

virtual const func _shaped_text_get_grapheme_bounds(pos: int) -> Vector2#

Optional.

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

virtual const func _shaped_text_get_inferred_direction(shaped: RID) -> intTextServer.Direction#

Optional.

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

virtual const func _shaped_text_get_line_breaks(break_flags: int enumTextServer.LineBreakFlag) -> PackedInt32Array#

Optional.

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

virtual const func _shaped_text_get_line_breaks_adv(break_flags: int enumTextServer.LineBreakFlag) -> PackedInt32Array#

Optional.

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

virtual const func _shaped_text_get_object_glyph(key: Variant) -> int#

Required.

Returns the glyph index of the inline object.

virtual const func _shaped_text_get_object_range(key: Variant) -> Vector2i#

Required.

Returns the character range of the inline object.

virtual const func _shaped_text_get_object_rect(key: Variant) -> Rect2#

Required.

Returns bounding rectangle of the inline object.

virtual const func _shaped_text_get_objects(shaped: RID) -> Array#

Required.

Returns array of inline objects.

virtual const func _shaped_text_get_orientation(shaped: RID) -> intTextServer.Orientation#

Optional.

Returns text orientation.

virtual const func _shaped_text_get_parent(shaped: RID) -> RID#

Required.

Returns the parent buffer from which the substring originates.

virtual const func _shaped_text_get_preserve_control(shaped: RID) -> bool#

Optional.

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

virtual const func _shaped_text_get_preserve_invalid(shaped: RID) -> bool#

Optional.

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

virtual const func _shaped_text_get_range(shaped: RID) -> Vector2i#

Required.

Returns substring buffer character range in the parent buffer.

virtual const func _shaped_text_get_selection(end: int) -> PackedVector2Array#

Optional.

Returns selection rectangles for the specified character range.

virtual const func _shaped_text_get_size(shaped: RID) -> Vector2#

Required.

Returns size of the text.

virtual const func _shaped_text_get_spacing(spacing: int enumTextServer.SpacingType) -> int#

Optional.

Returns extra spacing added between glyphs or lines in pixels.

virtual const func _shaped_text_get_trim_pos(shaped: RID) -> int#

Required.

Returns the position of the overrun trim.

virtual const func _shaped_text_get_underline_position(shaped: RID) -> float#

Required.

Returns pixel offset of the underline below the baseline.

virtual const func _shaped_text_get_underline_thickness(shaped: RID) -> float#

Required.

Returns thickness of the underline.

virtual const func _shaped_text_get_width(shaped: RID) -> float#

Required.

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

virtual const func _shaped_text_get_word_breaks(skip_grapheme_flags: int enumTextServer.GraphemeFlag) -> PackedInt32Array#

Optional.

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

virtual const func _shaped_text_hit_test_grapheme(coord: float) -> int#

Optional.

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

virtual const func _shaped_text_hit_test_position(coord: float) -> int#

Optional.

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

virtual const func _shaped_text_is_ready(shaped: RID) -> bool#

Required.

Returns true if buffer is successfully shaped.

virtual const func _shaped_text_next_character_pos(pos: int) -> int#

Optional.

Returns composite character end position closest to the pos.

virtual const func _shaped_text_next_grapheme_pos(pos: int) -> int#

Optional.

Returns grapheme end position closest to the pos.

virtual func _shaped_text_overrun_trim_to_width(trim_flags: int enumTextServer.TextOverrunFlag) -> void#

Optional.

Trims text if it exceeds the given width.

virtual const func _shaped_text_prev_character_pos(pos: int) -> int#

Optional.

Returns composite character start position closest to the pos.

virtual const func _shaped_text_prev_grapheme_pos(pos: int) -> int#

Optional.

Returns grapheme start position closest to the pos.

virtual func _shaped_text_resize_object(baseline: float) -> bool#

Required.

Sets new size and alignment of embedded object.

virtual func _shaped_text_set_bidi_override(override: Array) -> void#

Optional.

Overrides BiDi for the structured text.

virtual func _shaped_text_set_custom_ellipsis(char: int) -> void#

Optional.

Sets ellipsis character used for text clipping.

virtual func _shaped_text_set_custom_punctuation(punct: String) -> void#

Optional.

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

virtual func _shaped_text_set_direction(direction: int enumTextServer.Direction) -> void#

Optional.

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

virtual func _shaped_text_set_orientation(orientation: int enumTextServer.Orientation) -> void#

Optional.

Sets desired text orientation.

virtual func _shaped_text_set_preserve_control(enabled: bool) -> void#

Optional.

If set to true text buffer will display control characters.

virtual func _shaped_text_set_preserve_invalid(enabled: bool) -> void#

Optional.

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

virtual func _shaped_text_set_spacing(value: int) -> void#

Optional.

Sets extra spacing added between glyphs or lines in pixels.

virtual func _shaped_text_shape(shaped: RID) -> bool#

Required.

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

virtual func _shaped_text_sort_logical(shaped: RID) -> const Glyph*#

Required.

Returns text glyphs in the logical order.

virtual const func _shaped_text_substr(length: int) -> RID#

Required.

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

virtual func _shaped_text_tab_align(tab_stops: PackedFloat32Array) -> float#

Optional.

Aligns shaped text to the given tab-stops.

virtual func _shaped_text_update_breaks(shaped: RID) -> bool#

Optional.

Updates break points in the shaped text. This method is called by default implementation of text breaking functions.

virtual func _shaped_text_update_justification_ops(shaped: RID) -> bool#

Optional.

Updates justification points in the shaped text. This method is called by default implementation of text justification functions.

virtual const func _spoof_check(string: String) -> bool#

Optional.

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

virtual const func _string_get_character_breaks(language: String) -> PackedInt32Array#

Optional.

Returns array of the composite character boundaries.

virtual const func _string_get_word_breaks(chars_per_line: int) -> PackedInt32Array#

Optional.

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.

virtual const func _string_to_lower(language: String) -> String#

Optional.

Returns the string converted to lowercase.

virtual const func _string_to_title(language: String) -> String#

Optional.

Returns the string converted to title case.

virtual const func _string_to_upper(language: String) -> String#

Optional.

Returns the string converted to uppercase.

virtual const func _strip_diacritics(string: String) -> String#

Optional.

Strips diacritics from the string.

virtual const func _tag_to_name(tag: int) -> String#

Optional.

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

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #