TextFilterResult

Show Deprecated
Not Creatable
Not Replicated

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

Summary

Methods

Properties

Methods

GetNonChatStringForBroadcastAsync

Yields

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.


Returns

Filtered text string.

GetNonChatStringForUserAsync

Yields

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.

Parameters

toUserId: number

Player.UserId of the user intended to see/receive the text.

Default Value: ""

Returns

Filtered text string.

Events