Class Translation

A language translation that maps a collection of strings to their individual translations.

Inheritance

Resource

RefCounted

Object

Translation

Derived

OptimizedTranslation

Remarks

Translations are resources that can be loaded and unloaded on demand. They map a collection of strings to their individual translations, and they also provide convenience methods for pluralization.

See Also

Internationalizing games

Locales

Properties

locale

The locale of the translation.

var locale : String = "en"

Property Value

String

Remarks

• void set_locale(String value)
• String get_locale

Methods

_get_message(StringName, StringName)

Qualifiers: virtualconst

Virtual method to override Translation.get_message.

StringName _get_message(StringName src_message, StringName context)

Parameters

src_message StringName

context StringName

_get_plural_message(StringName, StringName, int, StringName)

Qualifiers: virtualconst

Virtual method to override Translation.get_plural_message.

StringName _get_plural_message(StringName src_message, StringName src_plural_message, int n, StringName context)

Parameters

src_message StringName

src_plural_message StringName

n int

context StringName

add_message(StringName, StringName, StringName)

Adds a message if nonexistent, followed by its translation.

An additional context could be used to specify the translation context or differentiate polysemic words.

void add_message(StringName src_message, StringName xlated_message, StringName context)

Parameters

src_message StringName

xlated_message StringName

context StringName

add_plural_message(StringName, PackedStringArray, StringName)

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.

void add_plural_message(StringName src_message, PackedStringArray xlated_messages, StringName context)

Parameters

src_message StringName

xlated_messages PackedStringArray

context StringName

erase_message(StringName, StringName)

Erases a message.

void erase_message(StringName src_message, StringName context)

Parameters

src_message StringName

context StringName

get_message(StringName, StringName)

Qualifiers: const

Returns a message's translation.

StringName get_message(StringName src_message, StringName context)

Parameters

src_message StringName

context StringName

get_message_count

Qualifiers: const

Returns the number of existing messages.

int get_message_count

get_message_list

Qualifiers: const

Returns all the messages (keys).

PackedStringArray get_message_list

get_plural_message(StringName, StringName, int, StringName)

Qualifiers: const

Returns a message's translation involving plurals.

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.

StringName get_plural_message(StringName src_message, StringName src_plural_message, int n, StringName context)

Parameters

src_message StringName

src_plural_message StringName

n int

context StringName

get_translated_message_list

Qualifiers: const

Returns all the messages (translated text).

PackedStringArray get_translated_message_list