2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-11-05 14:02:42 +00:00
<class name= "TranslationServer" inherits= "Object" version= "3.5" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-11-19 04:20:05 +00:00
Server that manages all translations.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2018-11-19 04:20:05 +00:00
Server that manages all translations. Translations can be set to it and removed from it.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2021-11-15 16:11:20 +00:00
<link > $DOCS_URL/tutorials/i18n/internationalizing_games.html</link>
<link > $DOCS_URL/tutorials/i18n/locales.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
<method name= "add_translation" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "translation" type= "Translation" />
2017-09-12 20:42:36 +00:00
<description >
2018-11-19 04:20:05 +00:00
Adds a [Translation] resource.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "clear" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2017-09-12 20:42:36 +00:00
<description >
2018-11-19 04:20:05 +00:00
Clears the server from all translations.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-04-27 17:11:39 +00:00
<method name= "get_loaded_locales" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Array" />
2019-04-27 17:11:39 +00:00
<description >
2021-09-16 07:27:56 +00:00
Returns an array of all loaded locales of the project.
2019-04-27 17:11:39 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_locale" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2021-09-16 07:27:56 +00: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 20:42:36 +00:00
</description>
</method>
2017-10-29 11:09:14 +00:00
<method name= "get_locale_name" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
<argument index= "0" name= "locale" type= "String" />
2017-10-29 11:09:14 +00:00
<description >
2019-06-21 23:04:47 +00: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 11:09:14 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "remove_translation" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "translation" type= "Translation" />
2017-09-12 20:42:36 +00:00
<description >
2018-11-19 04:20:05 +00:00
Removes the given translation from the server.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_locale" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "locale" type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2021-09-16 07:27:56 +00: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 20:42:36 +00:00
</description>
</method>
<method name= "translate" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
<argument index= "0" name= "message" type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2018-11-19 04:20:05 +00:00
Returns the current locale's translation for the given message (key).
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>