godot/doc/classes/Translation.xml
Rémi Verschelde e92c09ba4e doc: Make all tutorial links track "latest" in master branch
While the master branch is in development state for the next stable branch,
its links should point to the "latest" docs branch, to ensure that users of
the unstable builds are linked to the relevant documentation.

Those links could be switched to stable branch subdomains before branching
off for a new major or minor release, to start tracking the frozen stable
docs branches.

See discussion in #29104.
2019-06-01 11:33:34 +02:00

66 lines
1.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Translation" inherits="Resource" category="Core" version="3.2">
<brief_description>
Language Translation.
</brief_description>
<description>
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
</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_message">
<return type="void">
</return>
<argument index="0" name="src_message" type="String">
</argument>
<argument index="1" name="xlated_message" type="String">
</argument>
<description>
Adds a message if nonexistent, followed by its translation.
</description>
</method>
<method name="erase_message">
<return type="void">
</return>
<argument index="0" name="src_message" type="String">
</argument>
<description>
Erases a message.
</description>
</method>
<method name="get_message" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="src_message" type="String">
</argument>
<description>
Returns a message's translation.
</description>
</method>
<method name="get_message_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of existing messages.
</description>
</method>
<method name="get_message_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Returns all the messages (keys).
</description>
</method>
</methods>
<members>
<member name="locale" type="String" setter="set_locale" getter="get_locale">
The locale of the translation.
</member>
</members>
<constants>
</constants>
</class>