TextFilterTranslatedResult¶
Holds the filtered source text and its filtered translations produced by TextService.FilterAndTranslateStringAsync().
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
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.
Inheritance¶
Object → Instance → TextFilterTranslatedResult
Properties¶
| Member | Signature | Summary |
|---|---|---|
SourceLanguage |
SourceLanguage: string |
The language of the original text that was filtered. |
SourceText |
SourceText: TextFilterResult |
The filtered form of the original, untranslated text. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetTranslationForLocale |
TextFilterTranslatedResult:GetTranslationForLocale(locale: string): TextFilterResult |
Returns the filtered translation of the source text for the given locale. |
GetTranslations |
TextFilterTranslatedResult:GetTranslations(): Dictionary |
Returns all filtered translations of the source text, keyed by language. |
Roblox reference: TextFilterTranslatedResult
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.