2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2020-02-01 01:03:48 +00:00
|
|
|
<class name="TranslationServer" inherits="Object" version="4.0">
|
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>
|
2019-06-01 09:33:32 +00:00
|
|
|
<link>https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link>
|
|
|
|
<link>https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link>
|
2017-09-12 20:42:36 +00:00
|
|
|
</tutorials>
|
|
|
|
<methods>
|
|
|
|
<method name="add_translation">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="translation" type="Translation">
|
|
|
|
</argument>
|
|
|
|
<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">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<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">
|
|
|
|
<return type="Array">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-06-17 06:42:04 +00:00
|
|
|
Returns an Array of all loaded locales of the game.
|
2019-04-27 17:11:39 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
2017-09-12 20:42:36 +00:00
|
|
|
<method name="get_locale" qualifiers="const">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Returns the current locale of the game.
|
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">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="locale" type="String">
|
|
|
|
</argument>
|
|
|
|
<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">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="translation" type="Translation">
|
|
|
|
</argument>
|
|
|
|
<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">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="locale" type="String">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Sets the locale of the game.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="translate" qualifiers="const">
|
2020-02-22 13:59:09 +00:00
|
|
|
<return type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</return>
|
2020-02-22 13:59:09 +00:00
|
|
|
<argument index="0" name="message" type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</argument>
|
|
|
|
<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>
|