diff options
Diffstat (limited to 'doc/classes/TranslationServer.xml')
| -rw-r--r-- | doc/classes/TranslationServer.xml | 83 |
1 files changed, 54 insertions, 29 deletions
diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index aaf7a4d160..029848be33 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -7,77 +7,102 @@ Server that manages all translations. Translations can be set to it and removed from it. </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> + <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_translation"> - <return type="void"> - </return> - <argument index="0" name="translation" type="Translation"> - </argument> + <return type="void" /> + <argument index="0" name="translation" type="Translation" /> <description> Adds a [Translation] resource. </description> </method> <method name="clear"> - <return type="void"> - </return> + <return type="void" /> <description> Clears the server from all translations. </description> </method> <method name="get_loaded_locales" qualifiers="const"> - <return type="Array"> - </return> + <return type="Array" /> <description> Returns an Array of all loaded locales of the game. </description> </method> <method name="get_locale" qualifiers="const"> - <return type="String"> - </return> + <return type="String" /> <description> Returns the current locale of the game. </description> </method> <method name="get_locale_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="locale" type="String"> - </argument> + <return type="String" /> + <argument index="0" name="locale" type="String" /> <description> Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). </description> </method> + <method name="get_translation_object"> + <return type="Translation" /> + <argument index="0" name="locale" type="String" /> + <description> + Returns the [Translation] instance based on the [code]locale[/code] passed in. + It will return a [code]nullptr[/code] if there is no [Translation] instance that matches the [code]locale[/code]. + </description> + </method> + <method name="pseudolocalize" qualifiers="const"> + <return type="StringName" /> + <argument index="0" name="message" type="StringName" /> + <description> + Returns the pseudolocalized string based on the [code]p_message[/code] passed in. + </description> + </method> + <method name="reload_pseudolocalization"> + <return type="void" /> + <description> + Reparses the pseudolocalization options and reloads the translation. + </description> + </method> <method name="remove_translation"> - <return type="void"> - </return> - <argument index="0" name="translation" type="Translation"> - </argument> + <return type="void" /> + <argument index="0" name="translation" type="Translation" /> <description> Removes the given translation from the server. </description> </method> <method name="set_locale"> - <return type="void"> - </return> - <argument index="0" name="locale" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="locale" type="String" /> <description> Sets the locale of the game. </description> </method> <method name="translate" qualifiers="const"> - <return type="StringName"> - </return> - <argument index="0" name="message" type="StringName"> - </argument> + <return type="StringName" /> + <argument index="0" name="message" type="StringName" /> + <argument index="1" name="context" type="StringName" default="""" /> + <description> + Returns the current locale's translation for the given message (key) and context. + </description> + </method> + <method name="translate_plural" qualifiers="const"> + <return type="StringName" /> + <argument index="0" name="message" type="StringName" /> + <argument index="1" name="plural_message" type="StringName" /> + <argument index="2" name="n" type="int" /> + <argument index="3" name="context" type="StringName" default="""" /> <description> - Returns the current locale's translation for the given message (key). + Returns the current locale's translation for the given message (key), plural_message and context. + 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="pseudolocalization_enabled" type="bool" setter="set_pseudolocalization_enabled" getter="is_pseudolocalization_enabled" default="false"> + If [code]true[/code], enables the use of pseudolocalization. See [member ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization] for details. + </member> + </members> <constants> </constants> </class> |