72 lines
2.5 KiB
XML
72 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="TranslationServer" inherits="Object" version="3.5">
|
|
<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/3.4/tutorials/i18n/internationalizing_games.html</link>
|
|
<link>https://docs.godotengine.org/en/3.4/tutorials/i18n/locales.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_translation">
|
|
<return type="void" />
|
|
<argument index="0" name="translation" type="Translation" />
|
|
<description>
|
|
Adds a [Translation] resource.
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void" />
|
|
<description>
|
|
Clears the server from all translations.
|
|
</description>
|
|
</method>
|
|
<method name="get_loaded_locales" qualifiers="const">
|
|
<return type="Array" />
|
|
<description>
|
|
Returns an array of all loaded locales of the project.
|
|
</description>
|
|
</method>
|
|
<method name="get_locale" qualifiers="const">
|
|
<return type="String" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="get_locale_name" qualifiers="const">
|
|
<return type="String" />
|
|
<argument index="0" name="locale" type="String" />
|
|
<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="remove_translation">
|
|
<return type="void" />
|
|
<argument index="0" name="translation" type="Translation" />
|
|
<description>
|
|
Removes the given translation from the server.
|
|
</description>
|
|
</method>
|
|
<method name="set_locale">
|
|
<return type="void" />
|
|
<argument index="0" name="locale" type="String" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="translate" qualifiers="const">
|
|
<return type="String" />
|
|
<argument index="0" name="message" type="String" />
|
|
<description>
|
|
Returns the current locale's translation for the given message (key).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|