Translator

Show Deprecated
Not Creatable
Not Replicated

The role of a Translator is to manufacture/return strings localized for the viewing player. it can be used to retrieve display-ready localized text from a LocalizationTable. The source of the Translator.LocaleId property, the set of tables it will search, and the order it will search them in depends on which method was used to create the Translator instance.

The input for a Translator is the original development language string and a context, where all or part of the context can be used to find a more precise/situational translation for the source string.

The Translator can also be used to manufacture translated strings with inserts (data replacements) which may change order based on the target language.

Summary

Properties

The locale of translated strings.

READ ONLY
NOT REPLICATED

Events

Methods

FormatByKey(key: string, args: Variant): string  

Returns the localized text string in a LocalizationTable based on its Translator locale, by key.

Translate(context: Instance, text: string): string  

Returns the localized text string in a LocalizationTable based on its Translator locale, by source lookup.

Properties

LocaleId

Read Only
Not Replicated

The Roblox locale of the output translated strings from this table, for example “en-us” or “es-es.” Defaults to "en-us".

Events

Methods

FormatByKey

Returns the localized text string in a LocalizationTable based on its Translator locale, by key. The optional args table is used for filling format parameters in the matching text entry.

Note that this method will throw an error in the following cases:

  • If none of the LocalizationTables available to this Translator include a value for the given key.
  • If the format string for the key uses numbered parameters and args is not an array.
  • If the format string uses named parameters and args is not a table of key-value pairs.
  • If args is missing values for parameters that are used in the matching format string.

See Localizing with Scripting for more details and usage examples of this function.

Parameters

key: string

The Key value to look up and translate.

args: Variant

To be provided if the Source text and translations contain format strings. Will be a Lua table of values or key-value pairs, depending on whether the format strings are numbered or named.


Returns

RobloxOnlyTranslate

Roblox Script Security

Parameters

context: Instance
text: string

Returns

Translate

Returns the localized text string in a LocalizationTable based on its Translator locale. This string will be in the context of the provided object, given the provided Source text.

See Localizing with Scripting for more details and usage examples of this function.

Context Overrides

In some cases, duplicate Source strings may have completely different translations in other languages. For example, the English noun "Screen" can indicate both a computer screen and a window screen, but the Spanish translations are completely different:

ABCDE
KeyContextSourceExamplees
ScreenPantalla
ScreenMosquitero

In these cases, the first argument to this function — a valid in-game Instance — can be used as a "tie breaker" when multiple GUI objects use the same source string. To implement this, specify the "path" to the Instance you'd like to override as the Context value of the translation data:

ABCDE
KeyContextSourceExamplees
workspace.ComputerScreen.SurfaceGui.TextLabelScreenPantalla
ScreenMosquitero

Then, when calling this function in a script, pass the same Instance as the first argument, followed by the Source lookup text as the second argument:


1local LocalizationService = game:GetService("LocalizationService")
2
3local success, translator = pcall(function()
4 return LocalizationService:GetTranslatorForPlayerAsync(game.Players.LocalPlayer)
5end)
6
7if success then
8 local trans = translator:Translate(workspace.ComputerScreen.SurfaceGui.TextLabel, "Screen")
9 print(trans)
10else
11 warn("Cannot load translator for player!")
12end
13

Parameters

context: Instance

A valid in-game Instance to use for context override as outlined above. Note that this argument can be arbitrary, for example game, if you don't require a context override.

text: string

The Source text to look up and translate.


Returns

The translated text.