112 lines
3.6 KiB
XML
112 lines
3.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="TranslationServer" inherits="Object" version="4.0">
|
|
<brief_description>
|
|
Server that manages all translations.
|
|
</brief_description>
|
|
<description>
|
|
Server that manages all translations. Translations can be set to it and removed from it.
|
|
</description>
|
|
<tutorials>
|
|
<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>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_translation">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="translation" type="Translation">
|
|
</argument>
|
|
<description>
|
|
Adds a [Translation] resource.
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Clears the server from all translations.
|
|
</description>
|
|
</method>
|
|
<method name="get_loaded_locales" qualifiers="const">
|
|
<return type="Array">
|
|
</return>
|
|
<description>
|
|
Returns an Array of all loaded locales of the game.
|
|
</description>
|
|
</method>
|
|
<method name="get_locale" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
Returns the current locale of the game.
|
|
</description>
|
|
</method>
|
|
<method name="get_locale_name" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="locale" type="String">
|
|
</argument>
|
|
<description>
|
|
Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]).
|
|
</description>
|
|
</method>
|
|
<method name="get_translation_object">
|
|
<return type="Translation">
|
|
</return>
|
|
<argument index="0" name="locale" type="String">
|
|
</argument>
|
|
<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>
|
|
<method name="remove_translation">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="translation" type="Translation">
|
|
</argument>
|
|
<description>
|
|
Removes the given translation from the server.
|
|
</description>
|
|
</method>
|
|
<method name="set_locale">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="locale" type="String">
|
|
</argument>
|
|
<description>
|
|
Sets the locale of the game.
|
|
</description>
|
|
</method>
|
|
<method name="translate" qualifiers="const">
|
|
<return type="StringName">
|
|
</return>
|
|
<argument index="0" name="message" type="StringName">
|
|
</argument>
|
|
<argument index="1" name="context" type="StringName" default="""">
|
|
</argument>
|
|
<description>
|
|
Returns the current locale's translation for the given message (key) and context.
|
|
</description>
|
|
</method>
|
|
<method name="translate_plural" qualifiers="const">
|
|
<return type="StringName">
|
|
</return>
|
|
<argument index="0" name="message" type="StringName">
|
|
</argument>
|
|
<argument index="1" name="plural_message" type="StringName">
|
|
</argument>
|
|
<argument index="2" name="n" type="int">
|
|
</argument>
|
|
<argument index="3" name="context" type="StringName" default="""">
|
|
</argument>
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|