2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "TranslationServer" inherits= "Object" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-11-19 05:20:05 +01:00
Server that manages all translations.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2018-11-19 05:20:05 +01:00
Server that manages all translations. Translations can be set to it and removed from it.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2020-08-05 14:43:40 +02:00
<link title= "Internationalizing games" > https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link>
<link title= "Locales" > https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "add_translation" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "translation" type= "Translation" />
2017-09-12 22:42:36 +02:00
<description >
2018-11-19 05:20:05 +01:00
Adds a [Translation] resource.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "clear" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 22:42:36 +02:00
<description >
2018-11-19 05:20:05 +01:00
Clears the server from all translations.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-04-27 19:11:39 +02:00
<method name= "get_loaded_locales" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
2019-04-27 19:11:39 +02:00
<description >
2021-09-16 09:27:56 +02:00
Returns an array of all loaded locales of the project.
2019-04-27 19:11:39 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_locale" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
2017-09-12 22:42:36 +02:00
<description >
2021-09-16 09:27:56 +02:00
Returns the current locale of the project.
See also [method OS.get_locale] and [method OS.get_locale_language] to query the locale of the user system.
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-10-29 12:09:14 +01:00
<method name= "get_locale_name" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
<argument index= "0" name= "locale" type= "String" />
2017-10-29 12:09:14 +01:00
<description >
2019-06-22 01:04:47 +02:00
Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]).
2017-10-29 12:09:14 +01:00
</description>
</method>
2020-08-07 13:17:12 +02:00
<method name= "get_translation_object" >
2021-07-30 15:28:05 +02:00
<return type= "Translation" />
<argument index= "0" name= "locale" type= "String" />
2020-08-07 13:17:12 +02:00
<description >
Returns the [Translation] instance based on the [code]locale[/code] passed in.
It will return a [code]nullptr[/code] if there is no [Translation] instance that matches the [code]locale[/code].
</description>
</method>
2021-08-08 17:07:57 +02:00
<method name= "pseudolocalize" qualifiers= "const" >
<return type= "StringName" />
<argument index= "0" name= "message" type= "StringName" />
<description >
Returns the pseudolocalized string based on the [code]p_message[/code] passed in.
</description>
</method>
<method name= "reload_pseudolocalization" >
<return type= "void" />
<description >
Reparses the pseudolocalization options and reloads the translation.
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "remove_translation" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "translation" type= "Translation" />
2017-09-12 22:42:36 +02:00
<description >
2018-11-19 05:20:05 +01:00
Removes the given translation from the server.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_locale" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "locale" type= "String" />
2017-09-12 22:42:36 +02:00
<description >
2021-09-16 09:27:56 +02:00
Sets the locale of the project. The [code]locale[/code] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
If translations have been loaded beforehand for the new locale, they will be applied.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "translate" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "StringName" />
<argument index= "0" name= "message" type= "StringName" />
<argument index= "1" name= "context" type= "StringName" default= """" />
2020-08-07 13:17:12 +02:00
<description >
Returns the current locale's translation for the given message (key) and context.
</description>
</method>
<method name= "translate_plural" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "StringName" />
<argument index= "0" name= "message" type= "StringName" />
<argument index= "1" name= "plural_message" type= "StringName" />
<argument index= "2" name= "n" type= "int" />
<argument index= "3" name= "context" type= "StringName" default= """" />
2017-09-12 22:42:36 +02:00
<description >
2020-08-07 13:17:12 +02:00
Returns the current locale's translation for the given message (key), plural_message and context.
The number [code]n[/code] 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.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
2021-08-08 17:07:57 +02:00
<members >
<member name= "pseudolocalization_enabled" type= "bool" setter= "set_pseudolocalization_enabled" getter= "is_pseudolocalization_enabled" default= "false" >
If [code]true[/code], enables the use of pseudolocalization. See [member ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization] for details.
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
</class>