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.

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

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:

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:

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

local LocalizationService = game:GetService("LocalizationService")

local success, translator = pcall(function()
	return LocalizationService:GetTranslatorForPlayerAsync(game.Players.LocalPlayer)
end)

if success then
	local trans = translator:Translate(workspace.ComputerScreen.SurfaceGui.TextLabel, "Screen")
	print(trans)
else
	warn("Cannot load translator for player!")
end