summaryrefslogtreecommitdiff
path: root/doc/classes/Translation.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Translation.xml')
-rw-r--r--doc/classes/Translation.xml63
1 files changed, 21 insertions, 42 deletions
diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml
index d286c6cf0c..4b83a2abf5 100644
--- a/doc/classes/Translation.xml
+++ b/doc/classes/Translation.xml
@@ -12,80 +12,59 @@
</tutorials>
<methods>
<method name="add_message">
- <return type="void">
- </return>
- <argument index="0" name="src_message" type="StringName">
- </argument>
- <argument index="1" name="xlated_message" type="StringName">
- </argument>
- <argument index="2" name="context" type="StringName" default="&quot;&quot;">
- </argument>
+ <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="&quot;&quot;" />
<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">
- </return>
- <argument index="0" name="src_message" type="StringName">
- </argument>
- <argument index="1" name="xlated_messages" type="PackedStringArray">
- </argument>
- <argument index="2" name="context" type="StringName" default="&quot;&quot;">
- </argument>
+ <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="&quot;&quot;" />
<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">
- </return>
- <argument index="0" name="src_message" type="StringName">
- </argument>
- <argument index="1" name="context" type="StringName" default="&quot;&quot;">
- </argument>
+ <return type="void" />
+ <argument index="0" name="src_message" type="StringName" />
+ <argument index="1" name="context" type="StringName" default="&quot;&quot;" />
<description>
Erases a message.
</description>
</method>
<method name="get_message" qualifiers="const">
- <return type="StringName">
- </return>
- <argument index="0" name="src_message" type="StringName">
- </argument>
- <argument index="1" name="context" type="StringName" default="&quot;&quot;">
- </argument>
+ <return type="StringName" />
+ <argument index="0" name="src_message" type="StringName" />
+ <argument index="1" name="context" type="StringName" default="&quot;&quot;" />
<description>
Returns a message's translation.
</description>
</method>
<method name="get_message_count" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the number of existing messages.
</description>
</method>
<method name="get_message_list" qualifiers="const">
- <return type="PackedStringArray">
- </return>
+ <return type="PackedStringArray" />
<description>
Returns all the messages (keys).
</description>
</method>
<method name="get_plural_message" qualifiers="const">
- <return type="StringName">
- </return>
- <argument index="0" name="src_message" type="StringName">
- </argument>
- <argument index="1" name="src_plural_message" type="StringName">
- </argument>
- <argument index="2" name="n" type="int">
- </argument>
- <argument index="3" name="context" type="StringName" default="&quot;&quot;">
- </argument>
+ <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="&quot;&quot;" />
<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.