LocalizationTable

The default IETF tag to use if the ''languageKey'' parameter is excluded from the LocalizationTable:GetString() method.

The object that is being targeted for localization by this table. Localization is applied to it and all of it's descendants.

The Roblox locale of the input key strings for this table, for example "en-us" or "es-es." This is typically the "development language" of the game. For a Translator that merges multiple LocalizationTable objects, it's the LocaleId of the Default LocalizationTable. Defaults to "en-us".

Deprecated. Prefer LocalizationTable:GetEntries(), which returns the same data as a structured array of dictionaries. Returns all entries in the LocalizationTable encoded as a JSON-formatted string, the legacy serialized representation of the table's contents. Each entry is an object containing its key, context, examples, and source fields (each omitted when empty) along with a values map of locale IDs to translated strings.

The GetEntries function returns an array of dictionaries contained in a given LocalizationTable, where each dictionary represents an entry of localization data.

To set the entries of a LocalizationTable, you can use LocalizationTable:SetEntries().

Each dictionary in the array contains the following fields:

The GetString function returns a translation based on the specified language and key.

Returns a Translator for entries in this LocalizationTable, in the specified language. The translator will first search in this table and then look in ancestor tables.

Removes an entry from the LocalizationTable, using the specified key, source, and context to narrow down the specific entry to be removed.

The entry is identified by the (key, source, context) triple. If key is non-empty it alone identifies the entry because keys are unique within the table. If key is empty the entry is matched by the (source, context) pair. When no matching entry exists the call is a silent no-op.

Removing an entry deletes all of its translations and metadata. To remove only a single locale's translation from an entry while keeping the entry itself, use LocalizationTable:RemoveEntryValue() instead.

Removes a single language translation from the LocalizationTable, using the provided key, source, context, and localeId to narrow down the specific entry to be modified.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). Once the entry is found, only the translation for localeId is erased; the entry itself and all other locale translations remain intact. The localeId is case-insensitive (it is canonicalized internally). If no matching entry exists, or the entry has no translation for localeId, the call is a silent no-op.

To remove the entire entry including all translations, use LocalizationTable:RemoveEntry(). To remove every translation of a given locale across all entries, use LocalizationTable:RemoveTargetLocale().

Deprecated in favor of LocalizationTable:RemoveEntry(). Calling RemoveKey is the same as making the following call to RemoveEntry:

Removes all translations from the LocalizationTable with the specified localeId.

This is a bulk operation that iterates every entry in the table and erases the translation for localeId from each one. Entries themselves are not removed even if they have no remaining translations after this call. To remove a single translation from one specific entry, use LocalizationTable:RemoveEntryValue() instead.

The SetContents function sets the contents of the LocalizationTable, via the legacy JSON format.

Sets the contents of the LocalizationTable.

The entries parameter should be an array of dictionaries in the same format as the one returned from the LocalizationTable:GetEntries() function.

Deprecated. Prefer LocalizationTable:SetEntryValue() for matching an entry by key, source, and context, or LocalizationTable:SetEntries() to set many entries at once. Sets the translation text for the locale targetLocaleId on the LocalizationTable entry identified by key, creating a new entry with an empty source and context if no entry with that key exists. When targetLocaleId matches the table's LocalizationTable.SourceLocaleId, the entry's Source field is also set to text.

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.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). If no matching entry exists, a new entry is created with the provided key, source, and newContext. The method throws an error if setting the new context would cause the entry to conflict with another existing entry that shares the same key, source, and context combination.

The Context field stores an Instance:GetFullName() path that the automatic text replacement system uses for disambiguation when multiple entries share the same Source 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.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). If no matching entry exists, a new entry is created with the provided key, source, and context. The new example value always overwrites any existing example text on the entry.

The Example field is an arbitrary metadata string. The text-capture tools use it to store a sample of parameterized content in context, but developers may store any helpful annotation.

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.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). If no matching entry exists, a new entry is created with newKey, the provided source, and context. The method throws an error if newKey would conflict with an existing entry's key, because keys must be unique within the table. If newKey equals the entry's current key the call is a no-op.

The Key field is an optional unique identifier for fast hash lookups via Translator:FormatByKey(). When non-empty it must be unique across the entire table.

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.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). If no matching entry exists, a new entry is created with the provided key, newSource, and context. The method throws an error if the resulting (key, newSource, context) combination would conflict with an existing entry. If newSource equals the entry's current source the call is a no-op.

The Source field is the original text in the source language used by the LocalizationService automatic text replacement system to match GUI text at runtime. Changing the source also recomputes the internal expression matcher, so parameterized format strings (e.g. {1:translate}) are re-parsed immediately.

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.

The entry is identified by the (key, source, context) triple (see LocalizationTable:RemoveEntry() for lookup rules). If no matching entry exists, a new entry is created with the provided key, source, and context — this throws an error if both key and source are empty. The localeId is case-insensitive (it is canonicalized internally).

If text is non-empty the translation is stored (or replaced) for localeId on that entry. The text must be a valid format string (parameters like {1:translate} must be well-formed or the call throws). If text is an empty string the translation for localeId is removed from the entry, equivalent to calling LocalizationTable:RemoveEntryValue().

To set multiple entries at once, use LocalizationTable:SetEntries().