Skip to content
Roblox API Reference

CloudLocalizationTable

  • Not creatable
  • Not replicated
Memory category
Instances
Own members
0
Inherited members
97
Subclasses
0
Siblings
1

Properties28

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Inherited fromLocalizationTable5

Property categoryBehavior

  • LocalizationTable.Contents: string = "[]"
    • Hidden
    • Not scriptable
    • Capabilities: Basic
  • LocalizationTable.Root: Instance
    Deprecated: This item is deprecated. Do not use it for new work.
    The object that is being targeted for localization by this table. Localization is applied to it and all of it's descendants.
    • Deprecated
    • Hidden
    • Not replicated
    • Capabilities: Basic

    Use RootLocalizationTable instead.

Property categoryLocalization

Methods59

Inherited fromObject3
  • Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
    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
Inherited fromLocalizationTable17
  • LocalizationTable:GetEntries(): { any }
    Returns an array of dictionaries, where each dictionary represents an entry of localization data.
    • Capabilities: Basic
    Returns
    TypeDescription
    { any }
    An array of dictionaries, where each dictionary represents an entry of localization data.
  • LocalizationTable:GetTranslator(localeId: string): Instance
    Returns a Translator for entries in this LocalizationTable, in the specified locale.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    localeId: string
    A Roblox locale identifier (for example, "en-us" or "es-es") specifying the language the returned Translator should target.
    Returns
    TypeDescription
    Instance
    The Translator instance for the specified locale.
  • LocalizationTable:RemoveEntry(key: string, source: string, context: string)
    Removes an entry from the LocalizationTable, using the specified key, source, and context to narrow down the specific entry to be removed.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry to remove. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path used for disambiguation. Used with source to identify the entry when key is empty.
  • LocalizationTable:RemoveEntryValue(key: string,source: string,context: string,localeId: string,)
    Removes a single language translation from the LocalizationTable, using the provided key, source, context, and localeId to narrow down the specific entry to be removed.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path used for disambiguation. Used with source to identify the entry when key is empty.
    localeId: string
    The locale identifier (for example, "fr-fr") whose translation should be removed from the entry.
  • LocalizationTable:RemoveTargetLocale(localeId: string)
    Removes all translations from the LocalizationTable with the specified localeId.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    localeId: string
    A Roblox locale identifier (for example, "fr-fr") specifying which language's translations to remove from all entries.
  • LocalizationTable:SetEntries(entries: any)
    Sets the contents of the LocalizationTable.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    entries: any
    An array of dictionaries in the same format returned by LocalizationTable:GetEntries(), each containing Key, Source, Context, Example, and Values fields.
  • LocalizationTable:SetEntryContext(key: string,source: string,context: string,newContext: string,)
    Sets the Context field of a LocalizationTable entry to newContext, using the specified key, source, and context to narrow down the entry that will have this change applied.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The current Instance:GetFullName() path of the entry. Used with source to identify the entry when key is empty.
    newContext: string
    The new context string to assign to the entry.
  • LocalizationTable:SetEntryExample(key: string,source: string,context: string,example: string,)
    Sets the Example field of a LocalizationTable entry to example, using the specified key, source, and context to narrow down the entry that will have this change applied.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path of the entry. Used with source to identify the entry when key is empty.
    example: string
    The new example text to assign to the entry, typically a sample of parameterized content in context.
  • LocalizationTable:SetEntryKey(key: string,source: string,context: string,newKey: string,)
    Sets the Key field of a LocalizationTable entry to newKey, using the specified key, source, and context to narrow down the entry that will have this change applied.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The current unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path of the entry. Used with source to identify the entry when key is empty.
    newKey: string
    The new key string to assign to the entry. Must be unique within the table if non-empty.
  • LocalizationTable:SetEntrySource(key: string,source: string,context: string,newSource: string,)
    Sets the Source field of a LocalizationTable entry to newSource, using the specified key, source, and context to narrow down the entry that will have this change applied.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The current source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path of the entry. Used with source to identify the entry when key is empty.
    newSource: string
    The new source text to assign to the entry. Used by the automatic text replacement system for matching GUI text at runtime.
  • LocalizationTable:SetEntryValue(key: string,source: string,context: string,localeId: string,text: string,)
    Sets the text of the specified localeId in a LocalizationTable entry, using the specified key, source, and context to narrow down the entry that will have this change applied.
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry. If non-empty, identifies the entry by itself.
    source: string
    The source text of the entry. Used with context to identify the entry when key is empty.
    context: string
    The Instance:GetFullName() path of the entry. Used with source to identify the entry when key is empty.
    localeId: string
    The Roblox locale identifier (for example, "fr-fr") for the translation to set or remove.
    text: string
    The translation text to store. If empty, the translation for the specified locale is removed from the entry.
  • LocalizationTable:SetIsExemptFromUGCAnalytics(value: boolean)
    • Roblox script security
    • Capabilities: Basic
    Parameters
    Parameter
    value: boolean
  • LocalizationTable:GetContents(): string
    Deprecated: This item has been superseded by LocalizationTable:GetEntries() which should be used in all new work.
    Returns the contents of the LocalizationTable serialized as a JSON string.
    • Deprecated
    • Capabilities: Basic
    Returns
    TypeDescription
    string
    The table's entries encoded as a JSON-formatted string.

    Use GetEntries instead.

  • LocalizationTable:GetString(targetLocaleId: string, key: string): string
    Deprecated: This item has been superseded by LocalizationTable:GetTranslator() which should be used in all new work.
    Returns a translation based on the specified language and key.
    • Deprecated
    • Capabilities: Basic
    Parameters
    ParameterDescription
    targetLocaleId: string
    Specified language.
    key: string
    An optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table.
    Returns
    TypeDescription
    string
    Translated string.

    Use GetTranslator instead.

  • LocalizationTable:RemoveKey(key: string)
    Deprecated: This item has been superseded by LocalizationTable:RemoveEntry() which should be used in all new work
    Deprecated in favor of LocalizationTable:RemoveEntry().
    • Deprecated
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key of the entry to remove.

    Use RemoveEntry instead.

  • LocalizationTable:SetContents(contents: string)
    Deprecated: This item has been superseded by LocalizationTable:SetEntries() which should be used in all new work
    Sets the contents of the LocalizationTable, via the legacy JSON format.
    • Deprecated
    • Capabilities: Basic
    Parameters
    ParameterDescription
    contents: string
    A JSON-formatted string encoding the table's entries, in the same format returned by LocalizationTable:GetContents().

    Use SetEntries instead.

  • LocalizationTable:SetEntry(key: string, targetLocaleId: string, text: string)
    Deprecated: This item has been superseded by LocalizationTable:SetEntries() which should be used in all new work.
    Sets the translation text for the targetLocaleId locale on the entry identified by key, creating the entry if it doesn't exist.
    • Deprecated
    • Capabilities: Basic
    Parameters
    ParameterDescription
    key: string
    The unique key identifying the entry. If no entry with this key exists, a new entry is created.
    targetLocaleId: string
    The Roblox locale identifier (for example, "en-us" or "fr-fr") for the translation to set.
    text: string
    The translation text to store for the specified locale.

    Use SetEntryValue instead.

Events10

Inherited fromObject1
Inherited fromInstance9