TextFilterTranslatedResult

Inherits from: Instance → Object

A TextFilterTranslatedResult is the object returned by TextService:FilterAndTranslateStringAsync(). It bundles the filtered source text together with filtered translations of that text into each requested target locale.

Read TextFilterTranslatedResult.SourceText and TextFilterTranslatedResult.SourceLanguage for the filtered original text and its language, call TextFilterTranslatedResult:GetTranslationForLocale() to retrieve the filtered translation for a single locale, or call TextFilterTranslatedResult:GetTranslations() to retrieve all of them at once.

Instances of this class cannot be created, parented, or replicated; they are only produced by the engine as the return value of the filtering call. That call, TextService:FilterAndTranslateStringAsync(), is deprecated, so new work should filter and translate chat through TextChatService instead.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, NotReplicated

Properties

Name	Type / Returns	Description
TextFilterTranslatedResult.SourceLanguage	string	The language of the original text that was filtered.
TextFilterTranslatedResult.SourceText	TextFilterResult	The filtered form of the original, untranslated text.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

TextFilterTranslatedResult.SourceLanguage

The language string of the original text that was submitted to TextService:FilterAndTranslateStringAsync(). This is the source language that the translations returned by TextFilterTranslatedResult:GetTranslations() were translated from. This property is read-only.

Field	Value
type	string
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

TextFilterTranslatedResult.SourceText

A TextFilterResult representing the filtered form of the original text that was submitted to TextService:FilterAndTranslateStringAsync(), in its TextFilterTranslatedResult.SourceLanguage. Use the returned TextFilterResult to obtain the correctly filtered string for each recipient before displaying the untranslated text. This property is read-only.

Field	Value
type	TextFilterResult
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

Methods

Name	Type / Returns	Description
TextFilterTranslatedResult:GetTranslationForLocale	TextFilterResult	Returns the filtered translation of the source text for the given locale.
TextFilterTranslatedResult:GetTranslations	Dictionary	Returns all filtered translations of the source text, keyed by language.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	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.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

TextFilterTranslatedResult:GetTranslationForLocale

Returns the filtered TextFilterResult for the translation of the source text into locale, or nil if the result contains no translation for that locale. The locale argument is normalized to its language before lookup, so locale variants that share a language resolve to the same translation.

Parameters

Name	Type	Default	Description
locale	string		The locale identifier of the translation to retrieve.

Returns

Type	Description
TextFilterResult	The filtered `TextFilterResult` for the requested locale, or `nil` if the result contains no translation for it.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

TextFilterTranslatedResult:GetTranslations

Returns a dictionary that maps each translation's language string to its filtered TextFilterResult. The keys are the languages that the source text was translated into for the requested target locales; use TextFilterTranslatedResult:GetTranslationForLocale() to look up a single locale directly.

Returns

Type	Description
Dictionary	A dictionary mapping each translation's language string to its filtered `TextFilterResult`.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.