Class:LocalizationTable — roblox

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

LocalizationTable is a class added on May 24, 2017. It inherits Instance. It is used internally by Roblox to handle language translations.

Properties

DevelopmentLanguage: string

HiddenThis property is not shown in the object browser and properties window.
Not replicatedThis member is not replicated across the network boundary.
DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationTable/DevelopmentLanguage.

Category: Localization.
Serialization: can load only.
Thread safety: read safe

Root: Instance

HiddenThis property is not shown in the object browser and properties window.
Not replicatedThis member is not replicated across the network boundary.
DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationTable/Root.

Category: Behavior.
Serialization: cannot load or save.
Thread safety: read safe

SourceLocaleId: string

This class member is missing documentation. Create or add to its subpage at Class:LocalizationTable/SourceLocaleId.

Category: Localization.
Serialization: can save and load.
Thread safety: read safe

Methods

GetContents(): string

DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:LocalizationTable/GetContents.

Thread safety: unsafe

GetEntries(): Array

This class member is missing documentation. Create or add to its subpage at Class:LocalizationTable/GetEntries.

Thread safety: unsafe

GetString(`targetLocaleId`: string, `key`: string): string

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`targetLocaleId`	string
`key`	string

Thread safety: unsafe

GetTranslator(`localeId`: string): Instance

Parameters
Name	Type
`localeId`	string

Thread safety: unsafe

RemoveEntry(`key`: string, `source`: string, `context`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string

Thread safety: unsafe

RemoveEntryValue(`key`: string, `source`: string, `context`: string, `localeId`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`localeId`	string

Thread safety: unsafe

RemoveKey(`key`: string): null

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`key`	string

Thread safety: unsafe

RemoveTargetLocale(`localeId`: string): null

Parameters
Name	Type
`localeId`	string

Thread safety: unsafe

SetContents(`contents`: string): null

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`contents`	string

Thread safety: unsafe

SetEntries(`entries`: Variant): null

Parameters
Name	Type
`entries`	Variant

Thread safety: unsafe

SetEntry(`key`: string, `targetLocaleId`: string, `text`: string): null

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`key`	string
`targetLocaleId`	string
`text`	string

Thread safety: unsafe

SetEntryContext(`key`: string, `source`: string, `context`: string, `newContext`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`newContext`	string

Thread safety: unsafe

SetEntryExample(`key`: string, `source`: string, `context`: string, `example`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`example`	string

Thread safety: unsafe

SetEntryKey(`key`: string, `source`: string, `context`: string, `newKey`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`newKey`	string

Thread safety: unsafe

SetEntrySource(`key`: string, `source`: string, `context`: string, `newSource`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`newSource`	string

Thread safety: unsafe

SetEntryValue(`key`: string, `source`: string, `context`: string, `localeId`: string, `text`: string): null

Parameters
Name	Type
`key`	string
`source`	string
`context`	string
`localeId`	string
`text`	string

Thread safety: unsafe

SetIsExemptFromUGCAnalytics(`value`: bool): null

Parameters
Name	Type
`value`	bool

Security: RobloxScriptSecurity.
Thread safety: unsafe

Removed members

Properties

Contents

External links

LocalizationTable in the Roblox Creator Documentation
LocalizationTable in the Roblox API Reference

Properties

DevelopmentLanguage: string

Root: Instance

SourceLocaleId: string

Methods

GetContents(): string

GetEntries(): Array

GetString(targetLocaleId: string, key: string): string

GetTranslator(localeId: string): Instance

RemoveEntry(key: string, source: string, context: string): null

RemoveEntryValue(key: string, source: string, context: string, localeId: string): null

RemoveKey(key: string): null

RemoveTargetLocale(localeId: string): null

SetContents(contents: string): null

SetEntries(entries: Variant): null

SetEntry(key: string, targetLocaleId: string, text: string): null

SetEntryContext(key: string, source: string, context: string, newContext: string): null

SetEntryExample(key: string, source: string, context: string, example: string): null

SetEntryKey(key: string, source: string, context: string, newKey: string): null

SetEntrySource(key: string, source: string, context: string, newSource: string): null

SetEntryValue(key: string, source: string, context: string, localeId: string, text: string): null

SetIsExemptFromUGCAnalytics(value: bool): null

Removed members

Properties

External links

GetString(`targetLocaleId`: string, `key`: string): string

GetTranslator(`localeId`: string): Instance

RemoveEntry(`key`: string, `source`: string, `context`: string): null

RemoveEntryValue(`key`: string, `source`: string, `context`: string, `localeId`: string): null

RemoveKey(`key`: string): null

RemoveTargetLocale(`localeId`: string): null

SetContents(`contents`: string): null

SetEntries(`entries`: Variant): null

SetEntry(`key`: string, `targetLocaleId`: string, `text`: string): null

SetEntryContext(`key`: string, `source`: string, `context`: string, `newContext`: string): null

SetEntryExample(`key`: string, `source`: string, `context`: string, `example`: string): null

SetEntryKey(`key`: string, `source`: string, `context`: string, `newKey`: string): null

SetEntrySource(`key`: string, `source`: string, `context`: string, `newSource`: string): null

SetEntryValue(`key`: string, `source`: string, `context`: string, `localeId`: string, `text`: string): null

SetIsExemptFromUGCAnalytics(`value`: bool): null