Skip to content
Roblox API Reference

LocalizationService

Handles automated translation.
  • Not creatable
  • Not replicated
  • Service
Memory category
Instances
Own members
30
Inherited members
75
Subclasses
0
Siblings
608

Properties35

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byLocalizationService12

Property categoryBehavior

  • LocalizationService.ForcePlayModeGameLocaleId: string = ""
    • Hidden
    • Not replicated
    • Local user security
    • Read capabilities: Basic
  • LocalizationService.ForcePlayModeRobloxLocaleId: string = ""
    • Hidden
    • Not replicated
    • Local user security
    • Read capabilities: Basic
  • LocalizationService.RobloxForcePlayModeGameLocaleId: string = ""
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Basic
  • LocalizationService.RobloxForcePlayModeRobloxLocaleId: string = ""
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Basic

Property categoryLocalization

  • LocalizationService.GameSourceLanguageId: string = ""
    • Hidden
    • Not scriptable
    • Capabilities: Basic
  • LocalizationService.IsImageCaptureEnabled: boolean = false
    • Hidden
    • Not scriptable
    • Roblox script security
    • Read capabilities: Basic
  • LocalizationService.IsTextScraperRunning: boolean = false
    • Hidden
    • Roblox script security
    • Read capabilities: Basic
  • LocalizationService.LocaleManifest: string = ""
    • Hidden
    • Not scriptable
    • Capabilities: Basic
  • LocalizationService.RobloxLocaleId: string = ""
    The locale ID used for localizing core and internal features.
    • Read only
    • Capabilities: Basic
  • LocalizationService.ShouldUseCloudTable: boolean = false
    • Hidden
    • Not scriptable
    • Roblox script security
    • Read capabilities: Basic
  • LocalizationService.ShouldUseImageLocalizationTable: boolean = false
    • Hidden
    • Not scriptable
    • Roblox script security
    • Read capabilities: Basic
  • LocalizationService.SystemLocaleId: string = ""
    The locale ID that the local player has set for their operating system.
    • Read only
    • Capabilities: Basic

Methods57

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byLocalizationService15
  • LocalizationService:GetCorescriptLocalizations(): { Instance }
    Returns a list of LocalizationTable objects used for localizing core scripts.
    • Capabilities: Basic
    Returns
    TypeDescription
    { Instance }
    A list of LocalizationTable objects used for localizing CoreScripts.
  • LocalizationService:GetCountryRegionForPlayerAsync(player: Instance): string
    Returns country/region code string according to player's client IP geolocation.
    • Yields
    • Capabilities: Basic
    Parameters
    ParameterDescription
    player: Instance
    The player that you are getting country/region information for.
    Returns
    TypeDescription
    string
    A string indicating the country/region code of a player.
  • LocalizationService:GetIsLoadingInternalTranslations(): boolean
    • Roblox script security
    • Capabilities: Basic
    Returns
    Type
    boolean
  • LocalizationService:GetTableEntries(instance: Instance? = nil): { any }
    Gets all entries used for automated localization.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    instance: Instance? = nil
    The Instance for which to retrieve the ordered localization table entries. If nil, only entries from the LocalizationService hierarchy and the cloud LocalizationTable are returned.
    Returns
    TypeDescription
    { any }
    An array of arrays, where each array is in the same format as described in LocalizationTable:GetEntries().
  • LocalizationService:GetTranslatorForLocaleAsync(locale: string): Instance
    Yields until the cloud LocalizationTable for the argument locale has been loaded - if available. Returns a Translator instance to be used for translations for the provided locale.
    • Yields
    • Capabilities: Basic
    Parameters
    ParameterDescription
    locale: string
    A Roblox supported language or locale code.
    Returns
    TypeDescription
    Instance
    The Translator instance for the specified locale.
  • LocalizationService:GetTranslatorForPlayerAsync(player: Instance): Instance
    Yields until the cloud LocalizationTable for the player's locale has been loaded - if available. Returns a Translator instance to be used for translations for the provided locale.
    • Yields
    • Capabilities: Basic
    Parameters
    ParameterDescription
    player: Instance
    The Player that you are getting the Translator for.
    Returns
    TypeDescription
    Instance
    The Translator instance for the specified locale.
  • LocalizationService:IsLoadingInternalTranslationsSettingChanged(newIsLoadingInternalTranslations: boolean)
    • Roblox script security
    • Capabilities: Basic
    Parameters
    Parameter
    newIsLoadingInternalTranslations: boolean
  • LocalizationService:PromptDownloadGameTableToCSV(table: Instance)
    • Yields
    • Roblox script security
    • Capabilities: Basic
    Parameters
    Parameter
    table: Instance
  • LocalizationService:PromptExportToCSVs()
    • Yields
    • Roblox script security
    • Capabilities: Basic
  • LocalizationService:PromptImportFromCSVs()
    • Yields
    • Roblox script security
    • Capabilities: Basic
  • LocalizationService:PromptUploadCSVToGameTable(): Instance
    • Yields
    • Roblox script security
    • Capabilities: Basic
    Returns
    Type
    Instance
  • LocalizationService:SetRobloxLocaleId(locale: string)
    • Roblox script security
    • Capabilities: Basic
    Parameters
    Parameter
    locale: string
  • LocalizationService:StartTextScraper()
    • Roblox script security
    • Capabilities: Basic
  • LocalizationService:StopTextScraper()
    • Roblox script security
    • Capabilities: Basic
  • LocalizationService:GetTranslatorForPlayer(player: Instance): Instance
    Deprecated: This function has been deprecated by LocalizationService:GetTranslatorForPlayerAsync(), which functions similarly except that it yields until the cloud table has loaded. Please use it in new work instead.
    Returns a Translator to be used for translations using the locale data loaded.
    • Deprecated
    • Capabilities: Basic
    Parameters
    ParameterDescription
    player: Instance
    The Player that you are getting the Translator for.
    Returns
    TypeDescription
    Instance
    The Translator instance for the specified locale.

    Use GetTranslatorForPlayerAsync instead.

Events13

Inherited fromObject1
Inherited fromInstance9
Defined byLocalizationService3