Outdated documentation
This documentation page refers to Godot
4.3,
and may be outdated or incorrect.
Additionally, this engine version is
no longer supported.
Check this page in the stable branch for the latest additions and corrections.
TranslationServer
Inherits: Object
The server responsible for language translations.
Description
The server that manages all language translations. Translations can be added to or removed from it.
Tutorials
Properties
|
Methods
void |
add_translation(translation: Translation) |
void |
clear() |
compare_locales(locale_a: String, locale_b: String) const |
|
get_all_countries() const |
|
get_all_languages() const |
|
get_all_scripts() const |
|
get_country_name(country: String) const |
|
get_language_name(language: String) const |
|
get_loaded_locales() const |
|
get_locale() const |
|
get_locale_name(locale: String) const |
|
get_script_name(script: String) const |
|
get_translation_object(locale: String) |
|
pseudolocalize(message: StringName) const |
|
void |
|
void |
remove_translation(translation: Translation) |
void |
set_locale(locale: String) |
standardize_locale(locale: String) const |
|
translate(message: StringName, context: StringName = &"") const |
|
translate_plural(message: StringName, plural_message: StringName, n: int, context: StringName = &"") const |
Property Descriptions
bool pseudolocalization_enabled = false 🔗
If true, enables the use of pseudolocalization. See ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization for details.
Method Descriptions
void add_translation(translation: Translation) 🔗
Adds a Translation resource.
void clear() 🔗
Clears the server from all translations.
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).
PackedStringArray get_all_countries() const 🔗
Returns an array of known country codes.
PackedStringArray get_all_languages() const 🔗
Returns array of known language codes.
PackedStringArray 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.
PackedStringArray get_loaded_locales() const 🔗
Returns an array of all loaded locales of the project.
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)").
String get_script_name(script: String) const 🔗
Returns a readable script name for the script code.
Returns the current locale of the editor.
Note: When called from an exported project returns the same value as get_locale.
Translation get_translation_object(locale: String) 🔗
Returns the Translation instance based on the locale passed in.
It will return null if there is no Translation instance that matches the locale.
StringName pseudolocalize(message: StringName) const 🔗
Returns the pseudolocalized string based on the message passed in.
void reload_pseudolocalization() 🔗
Reparses the pseudolocalization options and reloads the translation.
void remove_translation(translation: Translation) 🔗
Removes the given translation from the server.
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) const 🔗
Returns a locale string standardized to match known locales (e.g. en-US would be matched to en_US).
StringName translate(message: StringName, context: StringName = &"") const 🔗
Returns the current locale's translation for the given message (key) and context.
StringName translate_plural(message: StringName, plural_message: StringName, n: int, context: StringName = &"") const 🔗
Returns the current locale's translation for the given message (key), 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.