Skip to content

LocalizationService

Not yet Class Services NotCreatable NotReplicated Service

Handles automated translation.

Not implemented yet

The localization backend is not implemented.

0 Nova members · 24 modern Roblox members not implemented yet

Description

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.

Inheritance

Object → Instance → LocalizationService

Properties

Member Signature Summary
ForcePlayModeGameLocaleId ForcePlayModeGameLocaleId: string —
ForcePlayModeRobloxLocaleId ForcePlayModeRobloxLocaleId: string —
GameSourceLanguageId GameSourceLanguageId: string —
IsImageCaptureEnabled IsImageCaptureEnabled: bool —
IsTextScraperRunning IsTextScraperRunning: bool —
LocaleManifest LocaleManifest: string —
RobloxForcePlayModeGameLocaleId RobloxForcePlayModeGameLocaleId: string —
RobloxForcePlayModeRobloxLocaleId RobloxForcePlayModeRobloxLocaleId: string —
RobloxLocaleId RobloxLocaleId: string The locale ID used for localizing core and internal features.
ShouldUseCloudTable ShouldUseCloudTable: bool —
ShouldUseImageLocalizationTable ShouldUseImageLocalizationTable: bool —
SystemLocaleId SystemLocaleId: string The locale ID that the local player has set for their operating system.

Methods

Member Signature Summary
GetCorescriptLocalizations LocalizationService:GetCorescriptLocalizations(): Instances Returns a list of LocalizationTable objects used for localizing core scripts.
GetCountryRegionForPlayerAsync LocalizationService:GetCountryRegionForPlayerAsync(player: Instance): string Returns country/region code string according to player's client IP geolocation.
GetIsLoadingInternalTranslations LocalizationService:GetIsLoadingInternalTranslations(): bool —
GetTableEntries LocalizationService:GetTableEntries(instance: Instance = nil): Array Gets all entries used for automated localization.
GetTranslatorForLocaleAsync LocalizationService:GetTranslatorForLocaleAsync(locale: string): Instance Yields until the cloud LocalizationTable for the argument locale has been loaded - if available. Returns a Translator instance t…
GetTranslatorForPlayer LocalizationService:GetTranslatorForPlayer(player: Instance): Instance Returns a Translator to be used for translations using the locale data loaded.
GetTranslatorForPlayerAsync LocalizationService:GetTranslatorForPlayerAsync(player: Instance): Instance Yields until the cloud LocalizationTable for the player's locale has been loaded - if available. Returns a Translator instance t…
IsLoadingInternalTranslationsSettingChanged LocalizationService:IsLoadingInternalTranslationsSettingChanged(newIsLoadingInternalTranslations: bool): null —
PromptDownloadGameTableToCSV LocalizationService:PromptDownloadGameTableToCSV(table: Instance): null —
PromptExportToCSVs LocalizationService:PromptExportToCSVs(): null —
PromptImportFromCSVs LocalizationService:PromptImportFromCSVs(): null —
PromptUploadCSVToGameTable LocalizationService:PromptUploadCSVToGameTable(): Instance —
SetRobloxLocaleId LocalizationService:SetRobloxLocaleId(locale: string): null —
StartTextScraper LocalizationService:StartTextScraper(): null —
StopTextScraper LocalizationService:StopTextScraper(): null —

Events

Member Signature Summary
AutoTranslateWillRun AutoTranslateWillRun() —
DynamicTranslationServerToClientResponse DynamicTranslationServerToClientResponse(entries: Tuple) —
TextScraperClientMessageWithPlayerSignal TextScraperClientMessageWithPlayerSignal(version: int, player: Instance, message: Tuple) —

Roblox reference: LocalizationService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.