LocalizationService

This property shows the locale id used for the localization of core and internal features such as CoreGui and CoreScripts.

This will return a string with the two letter code (for example, "en-us") for the locale.

This property shows the locale id that the local player has set for their operating system.

This will return a string with the two letter code (for example, "en-us") for the locale.

Returns a list of LocalizationTable objects used for localizing CoreScripts.

Returns

Returns an Array, where each element of the returned Array is itself an Array of entries in the same format as described in LocalizationTable:GetEntries(). The order of the elements in the returned Array is the same order that the LocalizationTables will be searched through to attempt autotranslation for the provided Instance. The entry elements within a particular LocalizationTable are returned in an unspecified order.

This function returns entries regardless of whether the object is a GuiBase2d with GuiBase2d.AutoLocalize enabled. An object that is a GuiBase2d will not actually be autotranslated unless GuiBase2d.AutoLocalize is enabled.

The ordering of the tables is as follows:

• First, it looks for the earliest GuiBase2d ancestor of the object (including the provided object) that has a GuiBase2d.RootLocalizationTable. Tables then append in the same order as described in GuiBase2d.RootLocalizationTable by going up through the LocalizationTable ancestors of that GuiBase2d.RootLocalizationTable. If no such GuiBase2d.RootLocalizationTable is found, no tables append in this step. If instance is nil, no tables append in this step.
• Next, tables from the LocalizationTable hierarchy under LocalizationService append. For each child LocalizationTable of LocalizationService, it appends tables going up from the lowest descendant LocalizationTable of the tables parented to the service, all the way up to the children of the service. If there are no children of LocalizationService that are LocalizationTables, then no tables append in this step.
• Finally, the cloud LocalizationTable appends to the array. If there is no cloud LocalizationTable, or the cloud LocalizationTable has not yet loaded, then no table appends in this step.

This function does not yield. It will not wait until the cloud LocalizationTable has loaded.

Parameters

Returns

This function takes a player as an argument and returns a Translator instance which can be used to perform translations for that locale if any are available. The entries used for localization are the entries provided by the LocalizationTable hierarchy under LocalizationService as well as the cloud LocalizationTable, if it is available and already loaded. This will be the same set of entries returned by LocalizationService.GetTableEntries().

This function does not yield. It will not wait until the cloud LocalizationTable has loaded.

See also:

• LocalizationService:GetTranslatorForPlayerAsync() has the same functionality as this function, except that it yields until the cloud LocalizationTable has been loaded.
• LocalizationService:GetTranslatorForLocaleAsync(), returns a Translator to be used for translations using the provided locale.

Parameters

Returns

local LocalizationService = game:GetService("LocalizationService")
local Players = game:GetService("Players")

local textLabel = script.Parent

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

if success then
	local result = translator:Translate(textLabel, "Hello World!")
	print(result)
else
	print("GetTranslatorForPlayerAsync failed: " .. translator)
end

Returns a country/region code string according to player's client IP geolocation. The supported country/region codes are as follows:

See also:

• PolicyService:GetPolicyInfoForPlayerAsync(), returns policy information about a player which is based on geolocation, age group and platform

Parameters

Returns

local LocalizationService = game:GetService("LocalizationService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

local result, code = pcall(LocalizationService.GetCountryRegionForPlayerAsync, LocalizationService, player)

if result and code == "CA" then
	print("Hello, friend from Canada!")
else
	print("GetCountryRegionForPlayerAsync failed: " .. code)
end

This function takes a locale code as an argument and yields until the cloud LocalizationTable for that locale has been loaded, if available. It then returns a Translator object which can be used to perform translations for that locale if any are available. The entries used for localization are the entries provided by the LocalizationTable hierarchy under LocalizationService as well as the cloud table (if available). This will be the same set of entries returned by LocalizationService.GetTableEntries().

This function can error and thus should be wrapped in a pcall().

See also:

• LocalizationService:GetTranslatorForPlayer() gets the translator corresponding to the locale of the provided player. This function is deprecated and should not be used in new work.
• LocalizationService:GetTranslatorForPlayerAsync() yields until the cloud LocalizationTable for the locale of the provided player has loaded and then gets the translator corresponding to the locale of the provided player.

Parameters

Returns

local LocalizationService = game:GetService("LocalizationService")

local textLabel = script.Parent

local success, translator = pcall(function()
	return LocalizationService:GetTranslatorForLocaleAsync("fr")
end)

if success then
	local result = translator:Translate(textLabel, "Hello World!")
	print("Hello in French: " .. result)
else
	print("GetTranslatorForLocaleAsync failed: " .. translator)
end

This function takes a player as an argument and yields until the cloud LocalizationTable for that player's locale has been loaded, if available. It then returns a Translator object which can be used to perform translations for that locale if any are available. The entries used for localization are the entries provided by the LocalizationTable hierarchy under LocalizationService as well as the cloud table (if available). This will be the same set of entries returned by GetTableEntries(nil).

This function can error and thus should be wrapped in a pcall().

See also:

• LocalizationService:GetTranslatorForPlayer(), same functionality as this function except that it does not yield and does not wait until the cloud LocalizationTable for the player's locale has been loaded. This function is deprecated and should not be used in new work.
• LocalizationService:GetTranslatorForLocaleAsync(), returns a Translator to be used for translations using the provided locale.

Parameters

Returns

local LocalizationService = game:GetService("LocalizationService")
local Players = game:GetService("Players")

local textLabel = script.Parent

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

if success then
	local result = translator:Translate(textLabel, "Hello World!")
	print(result)
else
	print("GetTranslatorForPlayerAsync failed: " .. translator)
end