Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TextFilterResult

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 3

HistoryMember
462GetChatForUserAsync(toUserId: int64): string
462GetNonChatStringForBroadcastAsync(): string
462GetNonChatStringForUserAsync(toUserId: int64): string
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

Represents the result of a call to TextService:FilterStringAsync(). Used to distribute a filtered string accordingly.

History 9

Members 3

GetChatForUserAsync

Parameters (1)
toUserIdint64
Returns (1)
string

This method returns the text in a properly filtered manner for the specified Player.UserId using the least restrictive filtering appropriate for that user, with Chat privacy settings of both users enforced. This should be used in the context of chats between players, although there are some other cases where text filtering is required.

The returned string should only be shown to the target user, as it might not be appropriate for all users.

If this method throws an error, the string should not be displayed to the user. Cases for error include:

  • The two users are not allowed to chat, for example if Chat:CanUserChatAsync() would return false for the given sender and receiver.
  • The user with the ID toUserId is not online on the current server.

This function will return immediately in most cases, although it will yield if the target user has just joined the server and their filtering info is not yet loaded.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 3

Tags: [Yields]

GetNonChatStringForBroadcastAsync

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

Returns the text in a properly filtered manner for all users. This should be used in the context of non-chat text that every user can see, such as for a dialog that lets a user write a message on a sign, visible to all users on the server even after the author has left.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetNonChatStringForUserAsync

Parameters (1)
toUserIdint64
Returns (1)
string

Returns the text in a properly filtered manner for the specified Player.UserId based on age and other details. This should be used in the context of non-chat text that one specific user can see, such as the name of a pet.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 3

Tags: [Yields]

Settings