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.

Checking the stable version of the documentation...

TranslationServer

Inherits: Object

The server responsible for language translations.

描述

The server that manages all language translations. Translations can be added to or removed from it.

教程

• Internationalizing games

• Locales

属性

bool

pseudolocalization_enabled

false

Methods

void	add_translation ( Translation translation )
void	clear ( )
int	compare_locales ( String locale_a, String locale_b ) const
PackedStringArray	get_all_countries ( ) const
PackedStringArray	get_all_languages ( ) const
PackedStringArray	get_all_scripts ( ) const
String	get_country_name ( String country ) const
String	get_language_name ( String language ) const
PackedStringArray	get_loaded_locales ( ) const
String	get_locale ( ) const
String	get_locale_name ( String locale ) const
String	get_script_name ( String script ) const
String	get_tool_locale ( )
Translation	get_translation_object ( String locale )
StringName	pseudolocalize ( StringName message ) const
void	reload_pseudolocalization ( )
void	remove_translation ( Translation translation )
void	set_locale ( String locale )
String	standardize_locale ( String locale ) const
StringName	translate ( StringName message, StringName context="" ) const
StringName	translate_plural ( StringName message, StringName plural_message, int n, StringName context="" ) const

---

Property Descriptions

bool pseudolocalization_enabled = false

• void set_pseudolocalization_enabled ( bool value )

• bool is_pseudolocalization_enabled ( )

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 ( String locale_a, String locale_b ) 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 ( String country ) const

Returns a readable country name for the country code.

---

String get_language_name ( String language ) 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.

---

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 ( String locale ) const

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

---

String get_script_name ( String script ) 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_translation_object ( String locale )

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 ( StringName message ) 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 ( String locale )

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 ( String locale ) const

Returns a locale string standardized to match known locales (e.g. en-US would be matched to en_US).

---

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

Returns the current locale's translation for the given message (key) and context.

---

StringName translate_plural ( StringName message, StringName plural_message, int n, StringName context="" ) 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.