PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

LocalizationService

Show deprecated

LocalizationService

Show deprecated

LocalizationService is the service responsible for handling automated translation.

It is used as a storage for LocalizationTable objects used by automatic text replacement.

LocalizationService will only use its child LocalizationTables for automatic text replacement unless GuiBase2d/RootLocalizationTable is specified on a GUI object or its ancestors.


Properties

string

ForcePlayModeGameLocaleId

[NotReplicated]
string

ForcePlayModeRobloxLocaleId

[NotReplicated]

When set to a non-empty string, this property overrides value of the LocalizationService/RobloxLocaleId when running in play solo mode.

bool

IsTextScraperRunning

[Hidden]

If true, the game is currently collecting strings from the game into a LocalizationTable.

string

RobloxForcePlayModeGameLocaleId

[NotReplicated]
string

RobloxForcePlayModeRobloxLocaleId

[NotReplicated]

When set to a non-empty string, this property overrides value of the LocalizationService/RobloxLocaleId when running in play solo mode. This property takes priority over LocalizationService/ForcePlayModeRobloxLocaleId.

string

RobloxLocaleId

[ReadOnly] [NotReplicated]

The locale id that the local player has set for their Roblox account.

string

SystemLocaleId

[ReadOnly] [NotReplicated]

The locale id that the local player has set for their operating system.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.

Instance

Parent

Determines the hierarchical parent of the Instance.

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to.

string

Name

A non-unique identifier of the Instance.

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

Functions

Objects

GetCorescriptLocalizations ( )

Returns a list of LocalizationTable objects that are parented to the LocalizationService.

Array

GetTableEntries ( Instance instance )

[Yields]
Instance

GetTranslatorForLocaleAsync ( string locale )

[Yields]

Yields until the cloud localization asset for the argument locale has been loaded - if available. Returns a Translator to be used for translations using the locale data loaded

Instance

GetTranslatorForPlayer ( Instance player )

Returns a Translator to be used for translations using the locale data loaded

Instance

GetTranslatorForPlayerAsync ( Instance player )

[Yields]

Yields until the cloud localization asset for the player’s locale has been loaded - if available. Returns a Translator to be used for translations using the locale data loaded

void

PromptDownloadGameTableToCSV ( Instance table )

[Yields]
Instance

PromptUploadCSVToGameTable ( )

[Yields]

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

bool

IsA ( string className )

Returns true if an Instance's class matches or inherits from a given class

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

RBXScriptSignal

AutoTranslateWillRun ( )

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.