Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

TextServerManager

Inherits: Object

A singleton for managing TextServer implementations.

Description

TextServerManager is the API backend for loading, enumerating, and switching TextServers.

Note: Switching text server at runtime is possible, but will invalidate all fonts and text buffers. Make sure to unload all controls, fonts, and themes before doing so.

Methods

void

add_interface ( TextServer interface )

TextServer

find_interface ( String name ) const

TextServer

get_interface ( int idx ) const

int

get_interface_count ( ) const

Dictionary[]

get_interfaces ( ) const

TextServer

get_primary_interface ( ) const

void

remove_interface ( TextServer interface )

void

set_primary_interface ( TextServer index )


Signals

interface_added ( StringName interface_name )

Emitted when a new interface has been added.


interface_removed ( StringName interface_name )

Emitted when an interface is removed.


Method Descriptions

void add_interface ( TextServer interface )

Registers a TextServer interface.


TextServer find_interface ( String name ) const

Finds an interface by its name.


TextServer get_interface ( int idx ) const

Returns the interface registered at a given index.


int get_interface_count ( ) const

Returns the number of interfaces currently registered.


Dictionary[] get_interfaces ( ) const

Returns a list of available interfaces, with the index and name of each interface.


TextServer get_primary_interface ( ) const

Returns the primary TextServer interface currently in use.


void remove_interface ( TextServer interface )

Removes an interface. All fonts and shaped text caches should be freed before removing an interface.


void set_primary_interface ( TextServer index )

Sets the primary TextServer interface.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.