A language translation that maps a collection of strings to their individual translations.
[Translation] maps a collection of strings to their individual translations, and also provides convenience methods for pluralization. A [Translation] consists of messages. A message is identified by its context and untranslated string. Unlike [url=https://www.gnu.org/software/gettext/]gettext[/url], using an empty context string in Godot means not using any context.
$DOCS_URL/tutorials/i18n/internationalizing_games.html $DOCS_URL/tutorials/i18n/localization_using_gettext.html $DOCS_URL/tutorials/i18n/locales.html
Virtual method to override [method get_message].
Virtual method to override [method get_plural_message].
Adds a message if nonexistent, followed by its translation. An additional context could be used to specify the translation context or differentiate polysemic words.
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.
Erases a message.
Returns a message's translation.
Returns the number of existing messages.
Returns the keys of all messages, that is, the context and untranslated strings of each message. [b]Note:[/b] If a message does not use a context, the corresponding element is the untranslated string. Otherwise, the corresponding element is the context and untranslated string separated by the EOT character ([code]U+0004[/code]). This is done for compatibility purposes. [codeblock] for key in translation.get_message_list(): var p = key.find("\u0004") if p == -1: var untranslated = key print("Message %s" % untranslated) else: var context = key.substr(0, p) var untranslated = key.substr(p + 1) print("Message %s with context %s" % [untranslated, context]) [/codeblock]
Returns a message's translation involving plurals. The number [param n] 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. [b]Note:[/b] Plurals are only supported in [url=$DOCS_URL/tutorials/i18n/localization_using_gettext.html]gettext-based translations (PO)[/url], not CSV.
Returns all the translated strings.
- The locale of the translation.
- The plural rules string to enforce. See [url=https://www.gnu.org/software/gettext/manual/html_node/Plural-forms.html]GNU gettext[/url] for examples and more info. If empty or invalid, default plural rules from [method TranslationServer.get_plural_rules] are used. The English plural rules are used as a fallback.