TextFilterResult

Show Deprecated
Not Creatable
Not Replicated

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

Summary

Properties

Events

Methods

GetChatForUserAsync(toUserId: number): string  YIELDS

Returns the text in a properly filtered manner for the specified Player.UserId.


Returns the text in a properly filtered manner for all users.


Returns the text in a properly filtered manner for the specified Player.UserId. This should be used in the context of non-chat text that another user can see, such as the name of a pet.

Properties

Events

Methods

GetChatForUserAsync

Yields

The GetChatForUserAsync function returns the text in a properly filtered manner for the specified Player.UserId. This should be used in the context of chats between players, although there are some other cases where text filtering is required.

This function returns the string appropriate for sending and displaying to a target user (specified by toUserId) from the original sender using the least restrictive filtering appropriate for the target user, with Chat privacy settings of both users enforced. This string should only be shown to the target user, as it might not be appropriate for all users.

This method throws an error if the two users are not allowed to chat (that is, if Chat:CanUserChatAsync() would return false for the given sender and receiver). If this method throws the string should not be displayed to the user. In addition, this function will throw an error if CanUserChatAsync would return false, so CanUserChatAsync should be called first to check.

This function currently throws an error if the user with the id toUserId is not online on the current server.

If text can be used for real-time or near real-time communication it should use this method.

This function will return immediately in most cases. The only time it will yield is if the target user is offline or has just joined the server and their filtering info is not yet loaded.

Parameters

toUserId: number

Id of the user being chatted.


Returns

Filtered text string.

GetNonChatStringForBroadcastAsync

Yields

Returns the text in a properly filtered manner for all users.


Returns

GetNonChatStringForUserAsync

Yields

Returns the text in a properly filtered manner for the specified Player.UserId. This should be used in the context of non-chat text that another user can see, such as the name of a pet.

Parameters

toUserId: number

Returns