Skip to content
Download
API reference

Localization

Inherits: Object

The server responsible for language translations.

The translation server is the API backend that manages all language translations.

Translations are stored in TranslationDomains, which can be accessed by name. The most commonly used translation domain is the main translation domain. It always exists and can be accessed using an empty StringName. The translation server provides wrapper methods for accessing the main translation domain directly, without having to fetch the translation domain first. Custom translation domains are mainly for advanced usages like editor plugins. Names starting with gobu. are reserved for engine internals.

TypeNameDefault
boolpseudolocalization_enabledfalse
ReturnsMethod
voidadd_translation(translation)
voidclear()
intcompare_locales(locale_a, locale_b)
[]Translationfind_translations(locale, exact)
Stringformat_number(number, locale)
[]Stringget_all_countries()
[]Stringget_all_languages()
[]Stringget_all_scripts()
Stringget_country_name(country)
Stringget_language_name(language)
[]Stringget_loaded_locales()
Stringget_locale()
Stringget_locale_name(locale)
TranslationDomainget_or_add_domain(domain)
Stringget_percent_sign(locale)
Stringget_plural_rules(locale)
Stringget_script_name(script)
Stringget_tool_locale()
[]Translationget_translations()
boolhas_domain(domain)
boolhas_translation(translation)
boolhas_translation_for_locale(locale, exact)
Stringparse_number(number, locale)
StringNamepseudolocalize(message)
voidreload_pseudolocalization()
voidremove_domain(domain)
voidremove_translation(translation)
voidset_locale(locale)
Stringstandardize_locale(locale, add_defaults)
StringNametranslate(message, context)
StringNametranslate_plural(message, plural_message, n, context)

bool pseudolocalization_enabled = false

Setter/getter: set_pseudolocalization_enabled(), is_pseudolocalization_enabled()

If true, enables the use of pseudolocalization on the main translation domain. See ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization for details.

void add_translation(translation: Translation)

Adds a translation to the main translation domain.

void clear()

Removes all translations from the main translation domain.

int compare_locales(locale_a: String, locale_b: String) const

Compares two locales and returns a similarity score between 0 (no match) and 10 (full match).

[]Translation find_translations(locale: String, exact: bool) const

Returns the Translation instances in the main translation domain that match locale (see compare_locales()). If exact is true, only instances whose locale exactly equals locale will be returned.

String format_number(number: String, locale: String) const

Converts a number from Western Arabic (0..9) to the numeral system used in the given locale.

[]String get_all_countries() const

Returns an array of known country codes.

[]String get_all_languages() const

Returns array of known language codes.

[]String get_all_scripts() const

Returns an array of known script codes.

String get_country_name(country: String) const

Returns a readable country name for the country code.

String get_language_name(language: String) const

Returns a readable language name for the language code.

[]String get_loaded_locales() const

Returns an array of all loaded locales of the project.

String get_locale() const

Returns the current locale of the project.

See also OS.get_locale() and OS.get_locale_language() to query the locale of the user system.

String get_locale_name(locale: String) const

Returns a locale’s language and its variant (e.g. "en_US" would return "English (United States)").

TranslationDomain get_or_add_domain(domain: StringName)

Returns the translation domain with the specified name. An empty translation domain will be created and added if it does not exist.

String get_percent_sign(locale: String) const

Returns the percent sign used in the given locale.

String get_plural_rules(locale: String) const

Returns the default plural rules for the locale.

String get_script_name(script: String) const

Returns a readable script name for the script code.

String get_tool_locale()

Returns the current locale of the editor.

Note: When called from an exported project returns the same value as get_locale().

[]Translation get_translations() const

Returns all available Translation instances in the main translation domain as added by add_translation().

bool has_domain(domain: StringName) const

Returns true if a translation domain with the specified name exists.

bool has_translation(translation: Translation) const

Returns true if the main translation domain contains the given translation.

bool has_translation_for_locale(locale: String, exact: bool) const

Returns true if there are any Translation instances in the main translation domain that match locale (see compare_locales()). If exact is true, only instances whose locale exactly equals locale are considered.

String parse_number(number: String, locale: String) const

Converts number from the numeral system used in the given locale to Western Arabic (0..9).

StringName pseudolocalize(message: StringName) const

Returns the pseudolocalized string based on the message passed in.

Note: This method always uses the main translation domain.

void reload_pseudolocalization()

Reparses the pseudolocalization options and reloads the translation for the main translation domain.

void remove_domain(domain: StringName)

Removes the translation domain with the specified name.

Note: Trying to remove the main translation domain is an error.

void remove_translation(translation: Translation)

Removes the given translation from the main translation domain.

void set_locale(locale: String)

Sets the locale of the project. The locale string will be standardized to match known locales (e.g. en-US would be matched to en_US).

If translations have been loaded beforehand for the new locale, they will be applied.

String standardize_locale(locale: String, add_defaults: bool = false) const

Returns a locale string standardized to match known locales (e.g. en-US would be matched to en_US). If add_defaults is true, the locale may have a default script or country added.

StringName translate(message: StringName, context: StringName = &"") const

Returns the current locale’s translation for the given message and context.

Note: This method always uses the main translation domain.

StringName translate_plural(message: StringName, plural_message: StringName, n: int, context: StringName = &"") const

Returns the current locale’s translation for the given message, plural message and context.

The number n is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.

Note: This method always uses the main translation domain.