Fill info for translation related docs
This commit is contained in:
@ -17,6 +17,7 @@
|
|||||||
<argument index="0" name="from" type="Translation">
|
<argument index="0" name="from" type="Translation">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Generates and sets an optimized translation from the given [Translation] resource.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|||||||
@ -7,6 +7,8 @@
|
|||||||
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
|
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
|
<link>https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html</link>
|
||||||
|
<link>https://docs.godotengine.org/en/stable/tutorials/i18n/locales.html</link>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<demos>
|
<demos>
|
||||||
</demos>
|
</demos>
|
||||||
@ -19,7 +21,7 @@
|
|||||||
<argument index="1" name="xlated_message" type="String">
|
<argument index="1" name="xlated_message" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Add a message for translation.
|
Adds a message if nonexistent, followed by its translation.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="erase_message">
|
<method name="erase_message">
|
||||||
@ -28,7 +30,7 @@
|
|||||||
<argument index="0" name="src_message" type="String">
|
<argument index="0" name="src_message" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Erase a message.
|
Erases a message.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_message" qualifiers="const">
|
<method name="get_message" qualifiers="const">
|
||||||
@ -37,25 +39,27 @@
|
|||||||
<argument index="0" name="src_message" type="String">
|
<argument index="0" name="src_message" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Return a message for translation.
|
Returns a message's translation.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_message_count" qualifiers="const">
|
<method name="get_message_count" qualifiers="const">
|
||||||
<return type="int">
|
<return type="int">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the number of existing messages.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_message_list" qualifiers="const">
|
<method name="get_message_list" qualifiers="const">
|
||||||
<return type="PoolStringArray">
|
<return type="PoolStringArray">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Return all the messages (keys).
|
Returns all the messages (keys).
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="locale" type="String" setter="set_locale" getter="get_locale">
|
<member name="locale" type="String" setter="set_locale" getter="get_locale">
|
||||||
|
The locale of the translation.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
|||||||
@ -1,11 +1,14 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="TranslationServer" inherits="Object" category="Core" version="3.1">
|
<class name="TranslationServer" inherits="Object" category="Core" version="3.1">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
Server that manages all translations. Translations can be set to it and removed from it.
|
Server that manages all translations.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
|
Server that manages all translations. Translations can be set to it and removed from it.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
|
<link>https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html</link>
|
||||||
|
<link>https://docs.godotengine.org/en/stable/tutorials/i18n/locales.html</link>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<demos>
|
<demos>
|
||||||
</demos>
|
</demos>
|
||||||
@ -16,18 +19,21 @@
|
|||||||
<argument index="0" name="translation" type="Translation">
|
<argument index="0" name="translation" type="Translation">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Adds a [Translation] resource.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="clear">
|
<method name="clear">
|
||||||
<return type="void">
|
<return type="void">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Clears the server from all translations.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_locale" qualifiers="const">
|
<method name="get_locale" qualifiers="const">
|
||||||
<return type="String">
|
<return type="String">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the current locale of the game.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_locale_name" qualifiers="const">
|
<method name="get_locale_name" qualifiers="const">
|
||||||
@ -36,6 +42,7 @@
|
|||||||
<argument index="0" name="locale" type="String">
|
<argument index="0" name="locale" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns a locale's language and its variant (e.g. "en_US" would return "English (United States)").
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="remove_translation">
|
<method name="remove_translation">
|
||||||
@ -44,6 +51,7 @@
|
|||||||
<argument index="0" name="translation" type="Translation">
|
<argument index="0" name="translation" type="Translation">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Removes the given translation from the server.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_locale">
|
<method name="set_locale">
|
||||||
@ -52,6 +60,7 @@
|
|||||||
<argument index="0" name="locale" type="String">
|
<argument index="0" name="locale" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Sets the locale of the game.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="translate" qualifiers="const">
|
<method name="translate" qualifiers="const">
|
||||||
@ -60,6 +69,7 @@
|
|||||||
<argument index="0" name="message" type="String">
|
<argument index="0" name="message" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the current locale's translation for the given message (key).
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|||||||
Reference in New Issue
Block a user