2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2020-02-01 01:03:48 +00:00
|
|
|
<class name="Translation" inherits="Resource" version="4.0">
|
2017-09-12 20:42:36 +00:00
|
|
|
<brief_description>
|
|
|
|
Language Translation.
|
|
|
|
</brief_description>
|
|
|
|
<description>
|
2019-06-21 23:04:47 +00:00
|
|
|
Translations are resources that can be loaded and unloaded on demand. They map a string to another string.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
2019-06-01 09:33:32 +00:00
|
|
|
<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>
|
2017-09-12 20:42:36 +00:00
|
|
|
</tutorials>
|
|
|
|
<methods>
|
|
|
|
<method name="add_message">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
2020-02-22 13:59:09 +00:00
|
|
|
<argument index="0" name="src_message" type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</argument>
|
2020-02-22 13:59:09 +00:00
|
|
|
<argument index="1" name="xlated_message" type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</argument>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Adds a message if nonexistent, followed by its translation.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="erase_message">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
2020-02-22 13:59:09 +00:00
|
|
|
<argument index="0" name="src_message" type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</argument>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Erases a message.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_message" qualifiers="const">
|
2020-02-22 13:59:09 +00:00
|
|
|
<return type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</return>
|
2020-02-22 13:59:09 +00:00
|
|
|
<argument index="0" name="src_message" type="StringName">
|
2017-09-12 20:42:36 +00:00
|
|
|
</argument>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Returns a message's translation.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_message_count" qualifiers="const">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Returns the number of existing messages.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_message_list" qualifiers="const">
|
2020-02-18 12:59:24 +00:00
|
|
|
<return type="PackedStringArray">
|
2017-09-12 20:42:36 +00:00
|
|
|
</return>
|
|
|
|
<description>
|
2018-11-19 04:20:05 +00:00
|
|
|
Returns all the messages (keys).
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<members>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="locale" type="String" setter="set_locale" getter="get_locale" default=""en"">
|
2018-11-19 04:20:05 +00:00
|
|
|
The locale of the translation.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|