f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
56 lines
1.7 KiB
XML
56 lines
1.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Translation" inherits="Resource" version="3.4">
|
|
<brief_description>
|
|
Language Translation.
|
|
</brief_description>
|
|
<description>
|
|
Translations are resources that can be loaded and unloaded on demand. They map a string to another string.
|
|
</description>
|
|
<tutorials>
|
|
<link>https://docs.godotengine.org/en/3.3/tutorials/i18n/internationalizing_games.html</link>
|
|
<link>https://docs.godotengine.org/en/3.3/tutorials/i18n/locales.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_message">
|
|
<return type="void" />
|
|
<argument index="0" name="src_message" type="String" />
|
|
<argument index="1" name="xlated_message" type="String" />
|
|
<description>
|
|
Adds a message if nonexistent, followed by its translation.
|
|
</description>
|
|
</method>
|
|
<method name="erase_message">
|
|
<return type="void" />
|
|
<argument index="0" name="src_message" type="String" />
|
|
<description>
|
|
Erases a message.
|
|
</description>
|
|
</method>
|
|
<method name="get_message" qualifiers="const">
|
|
<return type="String" />
|
|
<argument index="0" name="src_message" type="String" />
|
|
<description>
|
|
Returns a message's translation.
|
|
</description>
|
|
</method>
|
|
<method name="get_message_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of existing messages.
|
|
</description>
|
|
</method>
|
|
<method name="get_message_list" qualifiers="const">
|
|
<return type="PoolStringArray" />
|
|
<description>
|
|
Returns all the messages (keys).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="locale" type="String" setter="set_locale" getter="get_locale" default=""en"">
|
|
The locale of the translation.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|