Class reference

TranslationDomain

Inherits RefCounted

A self-contained collection of Translation resources.

Description

TranslationDomain is a self-contained collection of Translation resources. Translations can be added to or removed from it. If you're working with the main translation domain, it is more convenient to use the wrap methods on TranslationServer.

Properties

`bool enabled = true`

If true, translation is enabled. Otherwise, translate() and translate_plural() will return the input message unchanged regardless of the current locale.

`bool pseudolocalization_accents_enabled = true`

Replace all characters with their accented variants during pseudolocalization. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`bool pseudolocalization_double_vowels_enabled = false`

Double vowels in strings during pseudolocalization to simulate the lengthening of text due to localization. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`bool pseudolocalization_enabled = false`

If true, enables pseudolocalization for the project. This can be used to spot untranslatable strings or layout issues that may occur once the project is localized to languages that have longer strings than the source language. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`float pseudolocalization_expansion_ratio = 0.0`

The expansion ratio to use during pseudolocalization. A value of 0.3 is sufficient for most practical purposes, and will increase the length of each string by 30%. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`bool pseudolocalization_fake_bidi_enabled = false`

If true, emulate bidirectional (right-to-left) text when pseudolocalization is enabled. This can be used to spot issues with RTL layout and UI mirroring that will crop up if the project is localized to RTL languages such as Arabic or Hebrew. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`bool pseudolocalization_override_enabled = false`

Replace all characters in the string with *. Useful for finding non-localizable strings. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`String pseudolocalization_prefix = "["`

Prefix that will be prepended to the pseudolocalized string. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`bool pseudolocalization_skip_placeholders_enabled = true`

Skip placeholders for string formatting like %s or %f during pseudolocalization. Useful to identify strings which need additional control characters to display correctly. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

`String pseudolocalization_suffix = "]"`

Suffix that will be appended to the pseudolocalized string. Note: Updating this property does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED notification manually after you have finished modifying pseudolocalization related options.

Methods

`void add_translation(Translation translation)`

Adds a translation.

`void clear()`

Removes all translations.

`String get_locale_override() const`

Returns the locale override of the domain. Returns an empty string if locale override is disabled.

`Translation get_translation_object(String locale) const`

Returns the Translation instance that best matches locale. Returns null if there are no matches.

`StringName pseudolocalize(StringName message) const`

Returns the pseudolocalized string based on the message passed in.

`void remove_translation(Translation translation)`

Removes the given translation.

`void set_locale_override(String locale)`

Sets the locale override of the domain. If locale is an empty string, locale override is disabled. Otherwise, locale will be standardized to match known locales (e.g. en-US would be matched to en_US). Note: Calling this method does not automatically update texts in the scene tree. Please propagate the MainLoop.NOTIFICATION_TRANSLATION_CHANGED signal manually.

`StringName translate(StringName message, StringName context = &"") const`

Returns the current locale's translation for the given message and context.

`StringName translate_plural(StringName message, StringName message_plural, int n, StringName context = &"") const`

Returns the current locale's translation for the given message, plural message and context. The number 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.

Source revision 5592dc3a7a61