LocalizationService

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

LocalizationService
Not creatableThis class cannot be instantiated. ServiceThis class is a service. Not replicatedThis class is not replicated.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Added in	276 (February 2017)
Memory category	Instances
Inheritance
Instance LocalizationService

The LocalizationService class, added for March 18, 2017, and get the inherits from Instance. It is used from Automatic Translations and is used by LocalizationTables.

Properties

ForcePlayModeGameLocaleId: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/ForcePlayModeGameLocaleId.

• Category: Behavior.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

ForcePlayModeRobloxLocaleId: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/ForcePlayModeRobloxLocaleId.

• Category: Behavior.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

IsTextScraperRunning: bool

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/IsTextScraperRunning.

• Category: Localization.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

RobloxForcePlayModeGameLocaleId: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/RobloxForcePlayModeGameLocaleId.

• Category: Behavior.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

RobloxForcePlayModeRobloxLocaleId: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/RobloxForcePlayModeRobloxLocaleId.

• Category: Behavior.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

RobloxLocaleId: string

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/RobloxLocaleId.

• Category: Localization.
• Serialization: cannot load or save.
• Thread safety: read safe

SystemLocaleId: string

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/SystemLocaleId.

• Category: Localization.
• Serialization: cannot load or save.
• Thread safety: read safe

Methods

GetCorescriptLocalizations(): Objects

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/GetCorescriptLocalizations.

• Thread safety: unsafe

GetCountryRegionForPlayerAsync(player: Instance): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
player	Instance

• Thread safety: unsafe

GetTableEntries(instance: Instance = nil): Array

Parameters

Name	Type	Default
instance	Instance	nil

• Thread safety: unsafe

GetTranslatorForLocaleAsync(locale: string): Instance

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
locale	string

• Thread safety: unsafe

GetTranslatorForPlayer(player: Instance): Instance

Parameters

Name	Type
player	Instance

• Thread safety: unsafe

GetTranslatorForPlayerAsync(player: Instance): Instance

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
player	Instance

• Thread safety: unsafe

PromptDownloadGameTableToCSV(table: Instance): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
table	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptExportToCSVs(): null

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/PromptExportToCSVs.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptImportFromCSVs(): null

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/PromptImportFromCSVs.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptUploadCSVToGameTable(): Instance

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/PromptUploadCSVToGameTable.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetRobloxLocaleId(locale: string): null

Parameters

Name	Type
locale	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

StartTextScraper(): null

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/StartTextScraper.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

StopTextScraper(): null

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/StopTextScraper.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Events

AutoTranslateWillRun()

This class member is missing documentation. Create or add to its subpage at Class:LocalizationService/AutoTranslateWillRun.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Removed members

Methods

• SetExperienceSettingsLocaleId

Properties

• LocaleId
• PreferredLanguage

External links

• LocalizationService in the Roblox Creator Documentation
• LocalizationService in the Roblox API Reference