LocalizationTable
CreatorHub

A LocalizationTable is a database of translations. It contains source strings and translations for various languages.

Memory category	Instances

Member index 22

History		Member
553		Contents: string
553		DevelopmentLanguage: string
553		IsExemptFromUGCAnalytics: bool
553		Root: Instance
553		SourceLocaleId: string
553		GetContents(): string
462		GetEntries(): Array
553		GetString(targetLocaleId: string, key: string): string
462		GetTranslator(localeId: string): Instance
573		RemoveEntry(key: string, source: string, context: string): null
573		RemoveEntryValue(key: string, source: string, context: string, localeId: string): null
573		RemoveKey(key: string): null
573		RemoveTargetLocale(localeId: string): null
573		SetContents(contents: string): null
573		SetEntries(entries: Variant): null
573		SetEntry(key: string, targetLocaleId: string, text: string): null
573		SetEntryContext(key: string, source: string, context: string, newContext: string): null
573		SetEntryExample(key: string, source: string, context: string, example: string): null
573		SetEntryKey(key: string, source: string, context: string, newKey: string): null
573		SetEntrySource(key: string, source: string, context: string, newSource: string): null
573		SetEntryValue(key: string, source: string, context: string, localeId: string, text: string): null
573		SetIsExemptFromUGCAnalytics(value: bool): null
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

A LocalizationTable is a database of translations. It contains source strings and translations for various languages. It is used with the Translator and LocalizationService auto-translator system to control text translations in the game. LocalizationTables are designed to be treated as resources, like a texture or a script. They are not optimized to be modified at runtime. Changing the contents of a table will cause the entire contents of the table to be replicated to all players.

LocalizationTable Entries

Each LocalizationTable contains a set of entries. Each entry contains the translations of the text, along with some special fields:

Key is an optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table.
Source is the original text in the source language that will be used by the LocalizationService automatic text replacement system to match GUI text and render a translation instead. The Source field can be filled by the text capture tools, or can be set manually. For key-based lookups the Source value can be used as a translation for LocalizationTable.SourceLocaleId if the entry doesn't have a translation for that locale. If Source is empty then the entry will not be used by the automatic replacement system.
Context is the full Instance name for the object that the text appeared on. Context is used for disambiguation by the automatic text replacement system. When multiple matches for the Source are found, the system will pick the best match by matching backwards from the end of the Context string. There are other more robust ways to handle disambiguation available as well, like using multiple tables with GuiBase2d.RootLocalizationTable.
Example is whatever you want it to be. If the text capture tool guessed some parameters for a string the Example field will contain an example of them used in context.

All of these fields are optional, but at least either Key or Source must be non-empty. No two entries can have the same Key, Source, and Context.

See Translating Dynamic Content for more information.

History 97
Hide member changes

573 Change ReturnType of SetIsExemptFromUGCAnalytics from void to null
573 Change ReturnType of SetEntryValue from void to null
573 Change ReturnType of SetEntrySource from void to null
573 Change ReturnType of SetEntryKey from void to null
573 Change ReturnType of SetEntryExample from void to null
573 Change ReturnType of SetEntryContext from void to null
573 Change ReturnType of SetEntry from void to null
573 Change ReturnType of SetEntries from void to null
573 Change ReturnType of SetContents from void to null
573 Change ReturnType of RemoveTargetLocale from void to null
573 Change ReturnType of RemoveKey from void to null
573 Change ReturnType of RemoveEntryValue from void to null
573 Change ReturnType of RemoveEntry from void to null
553 Change PreferredDescriptor of SetEntry from to SetEntryValue
553 Change PreferredDescriptor of SetContents from to SetEntries
553 Change PreferredDescriptor of RemoveKey from to RemoveEntry
553 Change PreferredDescriptor of GetString from to GetTranslator
553 Change PreferredDescriptor of GetContents from to GetEntries
553 Change Default of SourceLocaleId from to en-us
553 Change Default of Root from to
553 Change PreferredDescriptor of Root from to RootLocalizationTable
553 Add IsExemptFromUGCAnalytics
553 Change PreferredDescriptor of DevelopmentLanguage from to SourceLocaleId
553 Change Default of DevelopmentLanguage from to en-us
553 Add Contents
486 Change ThreadSafety of SourceLocaleId from ReadOnly to ReadSafe
486 Change ThreadSafety of Root from ReadOnly to ReadSafe
486 Change ThreadSafety of DevelopmentLanguage from ReadOnly to ReadSafe
462 Change ThreadSafety of SetIsExemptFromUGCAnalytics from to Unsafe
462 Change ThreadSafety of SetEntryValue from to Unsafe
462 Change ThreadSafety of SetEntrySource from to Unsafe
462 Change ThreadSafety of SetEntryKey from to Unsafe
462 Change ThreadSafety of SetEntryExample from to Unsafe
462 Change ThreadSafety of SetEntryContext from to Unsafe
462 Change ThreadSafety of SetEntry from to Unsafe
462 Change ThreadSafety of SetEntries from to Unsafe
462 Change ThreadSafety of SetContents from to Unsafe
462 Change ThreadSafety of RemoveTargetLocale from to Unsafe
462 Change ThreadSafety of RemoveKey from to Unsafe
462 Change ThreadSafety of RemoveEntryValue from to Unsafe
462 Change ThreadSafety of RemoveEntry from to Unsafe
462 Change ThreadSafety of GetTranslator from to Unsafe
462 Change ThreadSafety of GetString from to Unsafe
462 Change ThreadSafety of GetEntries from to Unsafe
462 Change ThreadSafety of GetContents from to Unsafe
462 Change ThreadSafety of SourceLocaleId from to ReadOnly
462 Change ThreadSafety of Root from to ReadOnly
462 Change ThreadSafety of DevelopmentLanguage from to ReadOnly
445 Add SetEntry
445 Add SetContents
445 Add RemoveKey
445 Add GetContents
445 Add DevelopmentLanguage
445 Remove SetEntry
445 Remove SetContents
445 Remove RemoveKey
445 Remove GetContents
445 Remove DevelopmentLanguage
337 Add SetIsExemptFromUGCAnalytics
329 Change ValueType of Root from Object to Instance
326 Add SetEntryValue
326 Add SetEntrySource
326 Add SetEntryKey
326 Add SetEntryExample
326 Add SetEntryContext
326 Change Tags of SetEntry from [] to [Deprecated]
326 Change Tags of SetContents from [] to [Deprecated]
326 Add RemoveTargetLocale
326 Change Tags of RemoveKey from [] to [Deprecated]
326 Add RemoveEntryValue
326 Add RemoveEntry
326 Change Tags of GetString from [] to [Deprecated]
326 Change Tags of GetContents from [] to [Deprecated]
326 Change Tags of Root from [NotReplicated] to [Hidden, NotReplicated, Deprecated]
322 Add SetEntries
322 Change Tags of SourceLocaleId from [Hidden] to []
322 Change Tags of DevelopmentLanguage from [NotReplicated] to [Hidden, NotReplicated, Deprecated]
319 Add GetTranslator
318 Add SourceLocaleId
317 Change Parameters of SetEntry from (key: string, locale: string, text: string) to (key: string, targetLocaleId: string, text: string)
317 Change Parameters of GetString from (languageKey: string, expressionKey: string) to (targetLocaleId: string, key: string)
307 Change Tags of Root from [Hidden, NotReplicated] to [NotReplicated]
307 Change Tags of DevelopmentLanguage from [Hidden, NotReplicated] to [NotReplicated]
304 Add SetEntry
304 Add SetContents
304 Add RemoveKey
304 Add GetEntries
304 Add GetContents
304 Remove Contents
295 Change Tags of Root from [NotReplicated] to [Hidden, NotReplicated]
295 Change Tags of DevelopmentLanguage from [NotReplicated] to [Hidden, NotReplicated]
295 Change Tags of Contents from [] to [Hidden]
292 Add GetString
292 Add Root
292 Add DevelopmentLanguage
292 Add Contents
292 Add LocalizationTable

Members 22

Contents
CreatorHub

Type		Default
string		[]

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

553 Add Contents
304 Remove Contents
295 Change Tags of Contents from [] to [Hidden]
292 Add Contents

Tags: [Hidden, NotScriptable]

DevelopmentLanguage
CreatorHub

Type		Default
string		en-us

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

It exists only for backward compatibility, and should not be used for new work. SourceLocaleId should be used instead.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Localization
Loaded/Saved	true/false

History 10

553 Change PreferredDescriptor of DevelopmentLanguage from to SourceLocaleId
553 Change Default of DevelopmentLanguage from to en-us
486 Change ThreadSafety of DevelopmentLanguage from ReadOnly to ReadSafe
462 Change ThreadSafety of DevelopmentLanguage from to ReadOnly
445 Add DevelopmentLanguage
445 Remove DevelopmentLanguage
322 Change Tags of DevelopmentLanguage from [NotReplicated] to [Hidden, NotReplicated, Deprecated]
307 Change Tags of DevelopmentLanguage from [Hidden, NotReplicated] to [NotReplicated]
295 Change Tags of DevelopmentLanguage from [NotReplicated] to [Hidden, NotReplicated]
292 Add DevelopmentLanguage

Tags: [Hidden, NotReplicated, Deprecated]

GetContents
CreatorHub

Parameters (0)
No parameters.
Returns (1)
string

It exists only for backward compatibility, and should not be used for new work. GetEntries should be used instead.

Thread safety	Unsafe

History 6

553 Change PreferredDescriptor of GetContents from to GetEntries
462 Change ThreadSafety of GetContents from to Unsafe
445 Add GetContents
445 Remove GetContents
326 Change Tags of GetContents from [] to [Deprecated]
304 Add GetContents

Tags: [Deprecated]

GetEntries
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Array

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:

Index	Type	Description
Key	string	A lookup key for this specific entry in the LocalizationTable.
Source	string	The string used to format the localized string. Used as a lookup if a key is not provided.
Context	string	An Instance:GetFullName() path to the object that was used to generate the LocalizationTable. Used as a lookup if a key is not provided.
Example	string	The string used to format the localization. Optional.
Values	`Dictionary`	A dictionary of language translations for this localization entry. The keys of this dictionary are locale ids, and the values are strings that are used to apply localization for the language corresponding to the locale id.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetEntries from to Unsafe
304 Add GetEntries

GetString
CreatorHub

Parameters (2)
targetLocaleId	string
key	string
Returns (1)
string

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

It exists only for backward compatibility, and should not be used for new work. GetTranslator should be used instead.

Thread safety	Unsafe

History 5

553 Change PreferredDescriptor of GetString from to GetTranslator
462 Change ThreadSafety of GetString from to Unsafe
326 Change Tags of GetString from [] to [Deprecated]
317 Change Parameters of GetString from (languageKey: string, expressionKey: string) to (targetLocaleId: string, key: string)
292 Add GetString

Tags: [Deprecated]

GetTranslator
CreatorHub

Parameters (1)
localeId	string
Returns (1)
Instance

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.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetTranslator from to Unsafe
319 Add GetTranslator

IsExemptFromUGCAnalytics
CreatorHub

Type		Default
bool		false

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Localization
Loaded/Saved	false

History 1

553 Add IsExemptFromUGCAnalytics

Tags: [Hidden, NotScriptable]

RemoveEntry
CreatorHub

Parameters (3)
key	string
source	string
context	string
Returns (1)
null

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

Thread safety	Unsafe

History 3

573 Change ReturnType of RemoveEntry from void to null
462 Change ThreadSafety of RemoveEntry from to Unsafe
326 Add RemoveEntry

RemoveEntryValue
CreatorHub

Parameters (4)
key	string
source	string
context	string
localeId	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of RemoveEntryValue from void to null
462 Change ThreadSafety of RemoveEntryValue from to Unsafe
326 Add RemoveEntryValue

RemoveKey
CreatorHub

Parameters (1)
key	string
Returns (1)
null

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

1	`LocalizationTable:RemoveEntry(key, "", "")`

It exists only for backward compatibility, and should not be used for new work. RemoveEntry should be used instead.

Thread safety	Unsafe

History 7

573 Change ReturnType of RemoveKey from void to null
553 Change PreferredDescriptor of RemoveKey from to RemoveEntry
462 Change ThreadSafety of RemoveKey from to Unsafe
445 Add RemoveKey
445 Remove RemoveKey
326 Change Tags of RemoveKey from [] to [Deprecated]
304 Add RemoveKey

Tags: [Deprecated]

RemoveTargetLocale
CreatorHub

Parameters (1)
localeId	string
Returns (1)
null

Removes all translations from the LocalizationTable with the specified localeId.

Thread safety	Unsafe

History 3

573 Change ReturnType of RemoveTargetLocale from void to null
462 Change ThreadSafety of RemoveTargetLocale from to Unsafe
326 Add RemoveTargetLocale

Root
CreatorHub

Type		Default
Instance

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

It exists only for backward compatibility, and should not be used for new work. RootLocalizationTable should be used instead.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 9

553 Change Default of Root from to
553 Change PreferredDescriptor of Root from to RootLocalizationTable
486 Change ThreadSafety of Root from ReadOnly to ReadSafe
462 Change ThreadSafety of Root from to ReadOnly
329 Change ValueType of Root from Object to Instance
326 Change Tags of Root from [NotReplicated] to [Hidden, NotReplicated, Deprecated]
307 Change Tags of Root from [Hidden, NotReplicated] to [NotReplicated]
295 Change Tags of Root from [NotReplicated] to [Hidden, NotReplicated]
292 Add Root

Tags: [Hidden, NotReplicated, Deprecated]

SetContents
CreatorHub

Parameters (1)
contents	string
Returns (1)
null

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

It exists only for backward compatibility, and should not be used for new work. SetEntries should be used instead.

Thread safety	Unsafe

History 7

573 Change ReturnType of SetContents from void to null
553 Change PreferredDescriptor of SetContents from to SetEntries
462 Change ThreadSafety of SetContents from to Unsafe
445 Add SetContents
445 Remove SetContents
326 Change Tags of SetContents from [] to [Deprecated]
304 Add SetContents

Tags: [Deprecated]

SetEntries
CreatorHub

Parameters (1)
entries	Variant
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntries from void to null
462 Change ThreadSafety of SetEntries from to Unsafe
322 Add SetEntries

SetEntry
CreatorHub

Parameters (3)
key	string
targetLocaleId	string
text	string
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work. SetEntryValue should be used instead.

Thread safety	Unsafe

History 8

573 Change ReturnType of SetEntry from void to null
553 Change PreferredDescriptor of SetEntry from to SetEntryValue
462 Change ThreadSafety of SetEntry from to Unsafe
445 Add SetEntry
445 Remove SetEntry
326 Change Tags of SetEntry from [] to [Deprecated]
317 Change Parameters of SetEntry from (key: string, locale: string, text: string) to (key: string, targetLocaleId: string, text: string)
304 Add SetEntry

Tags: [Deprecated]

SetEntryContext
CreatorHub

Parameters (4)
key	string
source	string
context	string
newContext	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntryContext from void to null
462 Change ThreadSafety of SetEntryContext from to Unsafe
326 Add SetEntryContext

SetEntryExample
CreatorHub

Parameters (4)
key	string
source	string
context	string
example	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntryExample from void to null
462 Change ThreadSafety of SetEntryExample from to Unsafe
326 Add SetEntryExample

SetEntryKey
CreatorHub

Parameters (4)
key	string
source	string
context	string
newKey	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntryKey from void to null
462 Change ThreadSafety of SetEntryKey from to Unsafe
326 Add SetEntryKey

SetEntrySource
CreatorHub

Parameters (4)
key	string
source	string
context	string
newSource	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntrySource from void to null
462 Change ThreadSafety of SetEntrySource from to Unsafe
326 Add SetEntrySource

SetEntryValue
CreatorHub

Parameters (5)
key	string
source	string
context	string
localeId	string
text	string
Returns (1)
null

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.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetEntryValue from void to null
462 Change ThreadSafety of SetEntryValue from to Unsafe
326 Add SetEntryValue

SetIsExemptFromUGCAnalytics
CreatorHub

Parameters (1)
value	bool
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SetIsExemptFromUGCAnalytics from void to null
462 Change ThreadSafety of SetIsExemptFromUGCAnalytics from to Unsafe
337 Add SetIsExemptFromUGCAnalytics

SourceLocaleId
CreatorHub

Type		Default
string		en-us

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".

Thread safety	ReadSafe
Category	Localization
Loaded/Saved	true

History 5

553 Change Default of SourceLocaleId from to en-us
486 Change ThreadSafety of SourceLocaleId from ReadOnly to ReadSafe
462 Change ThreadSafety of SourceLocaleId from to ReadOnly
322 Change Tags of SourceLocaleId from [Hidden] to []
318 Add SourceLocaleId

Engine API

Website

Related

LocalizationTable Entries

History 4

History 10

History 6

History 2

History 5

History 2

History 1

History 3

History 3

History 7

History 3

History 9

History 7

History 3

History 8

History 3

History 3

History 3

History 3

History 3

History 3

History 5