mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
7adf4cc9b5
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.
82 lines
3.3 KiB
XML
82 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Translation" inherits="Resource" version="4.0">
|
|
<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 title="Internationalizing games">https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link>
|
|
<link title="Locales">https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_message">
|
|
<return type="void" />
|
|
<argument index="0" name="src_message" type="StringName" />
|
|
<argument index="1" name="xlated_message" type="StringName" />
|
|
<argument index="2" name="context" type="StringName" default="""" />
|
|
<description>
|
|
Adds a message if nonexistent, followed by its translation.
|
|
An additional context could be used to specify the translation context or differentiate polysemic words.
|
|
</description>
|
|
</method>
|
|
<method name="add_plural_message">
|
|
<return type="void" />
|
|
<argument index="0" name="src_message" type="StringName" />
|
|
<argument index="1" name="xlated_messages" type="PackedStringArray" />
|
|
<argument index="2" name="context" type="StringName" default="""" />
|
|
<description>
|
|
Adds a message involving plural translation if nonexistent, followed by its translation.
|
|
An additional context could be used to specify the translation context or differentiate polysemic words.
|
|
</description>
|
|
</method>
|
|
<method name="erase_message">
|
|
<return type="void" />
|
|
<argument index="0" name="src_message" type="StringName" />
|
|
<argument index="1" name="context" type="StringName" default="""" />
|
|
<description>
|
|
Erases a message.
|
|
</description>
|
|
</method>
|
|
<method name="get_message" qualifiers="const">
|
|
<return type="StringName" />
|
|
<argument index="0" name="src_message" type="StringName" />
|
|
<argument index="1" name="context" type="StringName" default="""" />
|
|
<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="PackedStringArray" />
|
|
<description>
|
|
Returns all the messages (keys).
|
|
</description>
|
|
</method>
|
|
<method name="get_plural_message" qualifiers="const">
|
|
<return type="StringName" />
|
|
<argument index="0" name="src_message" type="StringName" />
|
|
<argument index="1" name="src_plural_message" type="StringName" />
|
|
<argument index="2" name="n" type="int" />
|
|
<argument index="3" name="context" type="StringName" default="""" />
|
|
<description>
|
|
Returns a message's translation involving plurals.
|
|
The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.
|
|
</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>
|