Translation

Inherits: Resource < RefCounted < Object

Inherited By: OptimizedTranslation

Language Translation.

Description

Translations are resources that can be loaded and unloaded on demand. They map a string to another string.

Tutorials

Properties

String

locale

"en"

Methods

StringName

_get_message ( StringName src_message, StringName context ) virtual const

StringName

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

void

add_message ( StringName src_message, StringName xlated_message, StringName context="" )

void

add_plural_message ( StringName src_message, PackedStringArray xlated_messages, StringName context="" )

void

erase_message ( StringName src_message, StringName context="" )

StringName

get_message ( StringName src_message, StringName context="" ) const

int

get_message_count ( ) const

PackedStringArray

get_message_list ( ) const

StringName

get_plural_message ( StringName src_message, StringName src_plural_message, int n, StringName context="" ) const

PackedStringArray

get_translated_message_list ( ) const


Property Descriptions

String locale = "en"

The locale of the translation.


Method Descriptions

StringName _get_message ( StringName src_message, StringName context ) virtual const

Virtual method to override get_message.


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

Virtual method to override get_plural_message.


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

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_plural_message ( StringName src_message, PackedStringArray xlated_messages, StringName context="" )

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 erase_message ( StringName src_message, StringName context="" )

Erases a message.


StringName get_message ( StringName src_message, StringName context="" ) const

Returns a message's translation.


int get_message_count ( ) const

Returns the number of existing messages.


PackedStringArray get_message_list ( ) const

Returns all the messages (keys).


StringName get_plural_message ( StringName src_message, StringName src_plural_message, int n, StringName context="" ) 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.


PackedStringArray get_translated_message_list ( ) const

Returns all the messages (translated text).