Handles automated translation.
Its interface does not cross the network boundary.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]
LocalizationService is the service responsible for handling automated
translation.
It is used as a storage for LocalizationTable objects used by
automatic text replacement.
LocalizationService will only use its child LocalizationTables for automatic
text replacement unless GuiBase2d.RootLocalizationTable is specified
on a GUI object or its ancestors.
Parameters (0) |
---|
No parameters. |
History 2
ForcePlayModeGameLocaleId
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 5
Tags: [Hidden, NotReplicated]
ForcePlayModeRobloxLocaleId
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 5
Tags: [Hidden, NotReplicated]
It cannot be accessed by script code.
It is not meant to be used, and may have unresolved issues.
History 1
Tags: [Hidden, NotScriptable]
GetCorescriptLocalizations
Parameters (0) |
---|
No parameters. |
Returns (1) |
---|
Instances |
History 4
GetCountryRegionForPlayerAsync
Returns a country/region code string according to player's client IP
geolocation. The supported country/region codes are as follows:
Code | Country/Region |
---|
US | United States |
GB | United Kingdom |
CA | Canada |
AF | Afghanistan |
AX | Aland Islands |
AL | Albania |
DZ | Algeria |
AS | American Samoa |
AD | Andorra |
AO | Angola |
AI | Anguilla |
AQ | Antarctica |
AG | Antigua and Barbuda |
AR | Argentina |
AM | Armenia |
AW | Aruba |
AU | Australia |
AT | Austria |
AZ | Azerbaijan |
BS | Bahamas |
BH | Bahrain |
BD | Bangladesh |
BB | Barbados |
BY | Belarus |
BE | Belgium |
BZ | Belize |
BJ | Benin |
BM | Bermuda |
BT | Bhutan |
BO | Bolivia |
BQ | Bonaire, Saint Eustatius and Saba |
BA | Bosnia and Herzegovina |
BW | Botswana |
BV | Bouvet Island |
BR | Brazil |
IO | British Indian Ocean Territory |
BN | Brunei Darussalam |
BG | Bulgaria |
BF | Burkina Faso |
BI | Burundi |
KH | Cambodia |
CM | Cameroon |
CV | Cape Verde |
KY | Cayman Islands |
CF | Central African Republic |
TD | Chad |
CL | Chile |
CN | China |
CX | Christmas Island |
CC | Cocos Islands |
CO | Colombia |
KM | Comoros |
CG | Congo |
CD | Congo (DRC) |
CK | Cook Islands |
CR | Costa Rica |
CI | Ivory Coast |
HR | Croatia |
CW | Curaçao |
CY | Cyprus |
CZ | Czech Republic |
DK | Denmark |
DJ | Djibouti |
DM | Dominica |
DO | Dominican Republic |
EC | Ecuador |
EG | Egypt |
SV | El Salvador |
GQ | Equatorial Guinea |
ER | Eritrea |
EE | Estonia |
ET | Ethiopia |
FK | Falkland Islands (Malvinas) |
FO | Faroe Islands |
FJ | Fiji |
FI | Finland |
FR | France |
GF | French Guiana |
PF | French Polynesia |
TF | French Southern Territories |
GA | Gabon |
GM | Gambia |
GE | Georgia |
DE | Germany |
Code | Country/Region |
---|
GH | Ghana |
GI | Gibraltar |
GR | Greece |
GL | Greenland |
GD | Grenada |
GP | Guadeloupe |
GU | Guam |
GT | Guatemala |
GG | Guernsey |
GN | Guinea |
GW | Guinea-Bissau |
GY | Guyana |
HT | Haiti |
HM | Heard Island and the McDonald Islands |
VA | Holy See |
HN | Honduras |
HK | Hong Kong |
HU | Hungary |
IS | Iceland |
IN | India |
ID | Indonesia |
IQ | Iraq |
IE | Ireland |
IM | Isle of Man |
IL | Israel |
IT | Italy |
JM | Jamaica |
JP | Japan |
JE | Jersey |
JO | Jordan |
KZ | Kazakhstan |
KE | Kenya |
KI | Kiribati |
KR | Korea |
KW | Kuwait |
KG | Kyrgyzstan |
LA | Laos |
LV | Latvia |
LB | Lebanon |
LS | Lesotho |
LR | Liberia |
LY | Libya |
LI | Liechtenstein |
LT | Lithuania |
LU | Luxembourg |
MO | Macao |
MK | Macedonia |
MG | Madagascar |
MW | Malawi |
MY | Malaysia |
MV | Maldives |
ML | Mali |
MT | Malta |
MH | Marshall Islands |
MQ | Martinique |
MR | Mauritania |
MU | Mauritius |
YT | Mayotte |
MX | Mexico |
FM | Micronesia |
MD | Moldova |
MC | Monaco |
MN | Mongolia |
ME | Montenegro |
MS | Montserrat |
MA | Morocco |
MZ | Mozambique |
MM | Myanmar |
NA | Namibia |
NR | Nauru |
NP | Nepal |
NL | Netherlands |
AN | Netherlands Antilles |
NC | New Caledonia |
NZ | New Zealand |
NI | Nicaragua |
NE | Niger |
NG | Nigeria |
NU | Niue |
NF | Norfolk Island |
MP | Northern Mariana Islands |
NO | Norway |
OM | Oman |
Code | Country/Region |
---|
PK | Pakistan |
PW | Palau |
PS | Palestine |
PA | Panama |
PG | Papua New Guinea |
PY | Paraguay |
PE | Peru |
PH | Philippines |
PN | Pitcairn Islands |
PL | Poland |
PT | Portugal |
PR | Puerto Rico |
QA | Qatar |
RE | Reunion |
RO | Romania |
RU | Russian Federation |
RW | Rwanda |
BL | Saint Barthelemy |
SH | Saint Helena, Ascension and Tristan da Cunha |
KN | Saint Kitts and Nevis |
LC | Saint Lucia |
MF | Saint Martin |
PM | Saint Pierre and Miquelon |
VC | Saint Vincent and the Grenadines |
WS | Samoa |
SM | San Marino |
ST | Sao Tome and Principe |
SA | Saudi Arabia |
SN | Senegal |
RS | Serbia |
SC | Seychelles |
SL | Sierra Leone |
SG | Singapore |
SX | Sint Maarten |
SK | Slovakia |
SI | Slovenia |
SB | Solomon Islands |
SO | Somalia |
ZA | South Africa |
GS | South Georgia and the South Sandwich Islands |
SS | South Sudan |
ES | Spain |
LK | Sri Lanka |
SR | Suriname |
SJ | Svalbard and Jan Mayen |
SZ | Swaziland |
SE | Sweden |
CH | Switzerland |
TW | Taiwan |
TJ | Tajikistan |
TZ | Tanzania |
TH | Thailand |
TL | Timor-Leste |
TG | Togo |
TK | Tokelau |
TO | Tonga |
TT | Trinidad and Tobago |
TN | Tunisia |
TR | Türkiye (Turkey) |
TM | Turkmenistan |
TC | Turks and Caicos Islands |
TV | Tuvalu |
UG | Uganda |
UA | Ukraine |
AE | United Arab Emirates |
UM | United States Minor Outlying Islands |
UY | Uruguay |
UZ | Uzbekistan |
VU | Vanuatu |
VE | Venezuela |
VN | Vietnam |
VG | Virgin Islands (British) |
VI | Virgin Islands (US) |
WF | Wallis and Futuna |
EH | Western Sahara |
YE | Yemen |
ZM | Zambia |
ZW | Zimbabwe |
CU | Cuba |
IR | Iran |
SY | Syria |
KP | North Korea |
See also:
It will block the calling thread until completion.
History 2
Tags: [Yields]
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 automated localization 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 automatically localized
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.
History 3
GetTranslatorForLocaleAsync
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(nil).
This function can error and thus should be wrapped in a pcall()
.
See also:
It will block the calling thread until completion.
History 2
Tags: [Yields]
GetTranslatorForPlayerAsync
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 LocalizationService:GetTableEntries(nil).
This function can error and thus should be wrapped in a pcall()
.
See also:
It will block the calling thread until completion.
History 2
Tags: [Yields]
It is not meant to be used, and may have unresolved issues.
History 5
Tags: [Hidden]
It cannot be accessed by script code.
It is not meant to be used, and may have unresolved issues.
History 1
Tags: [Hidden, NotScriptable]
Parameters (0) |
---|
No parameters. |
Returns (1) |
---|
null |
It will block the calling thread until completion.
History 4
Tags: [Yields]
Parameters (0) |
---|
No parameters. |
Returns (1) |
---|
null |
It will block the calling thread until completion.
History 4
Tags: [Yields]
RobloxForcePlayModeGameLocaleId
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 5
Tags: [Hidden, NotReplicated]
RobloxForcePlayModeRobloxLocaleId
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 5
Tags: [Hidden, NotReplicated]
This property shows the locale ID used for the localization of core and
internal features such as CoreGui. Returns a string with the two
letter code (for example, en-us
) for the locale.
Its interface does not cross the network boundary.
Its value can be read, but it cannot be modified.
History 5
Tags: [ReadOnly, NotReplicated]
It cannot be accessed by script code.
It is not meant to be used, and may have unresolved issues.
History 1
Tags: [Hidden, NotScriptable]
Parameters (0) |
---|
No parameters. |
Returns (1) |
---|
null |
History 5
Parameters (0) |
---|
No parameters. |
Returns (1) |
---|
null |
History 3
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.
See also Player.LocaleId, the locale ID that a user has set for
their Roblox account which is used for localizing in-experience content.
This will be a different value when Roblox does not yet internally support
that player's locale.
Its interface does not cross the network boundary.
Its value can be read, but it cannot be modified.
History 3
Tags: [ReadOnly, NotReplicated]
TextScraperClientMessageWithPlayerSignal
It is not meant to be used, and may have unresolved issues.
History 1
Tags: [Hidden]
Its value can be read, but it cannot be modified.
History 2
Tags: [ReadOnly]
Its value can be read, but it cannot be modified.
History 2
Tags: [ReadOnly]
SetExperienceSettingsLocaleId
History 2