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

Property Descriptions

Default

"en"

Setter

set_locale(value)

Getter

get_locale()

The locale of the translation.

Method Descriptions

Virtual method to override get_message.


Virtual method to override 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.


  • int get_message_count ( ) const

Returns the number of existing messages.


Returns all the messages (keys).


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.