1. apireference
2. utility
3. textservice

FilterStringAsync

Parameters

Name	Type	Default	Description
Name stringToFilter	Type string	Default	Summary The text to be filtered.
Name fromUserId	Type int64	Default	Summary The userId of the player filtering the text.
Name textContext	Type TextFilterContext	Default PrivateChat	Summary The context that the filtered message will be used in. The default is PrivateChat.

Returns

Return Type	Summary
Return Type Instance	Summary Can be used to distribute the correctly filtered text accordingly.

---

Code Samples

---

Pet Name Filter Example

This code sample includes a simple demonstration of how TextService/FilterStringAsync should be implemented in a system where players are allowed to name their pets.

Note, this code sample includes the server-side implementation only (to be placed in a Script). Examples of how to implement the client-side of this system are included under the RemoteEvent and RemoteFunction examples.

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local TextService = game:GetService("TextService")
local Players = game:GetService("Players")

-- Define remotes for communication with client
local Remotes = Instance.new("Folder", ReplicatedStorage)
Remotes.Name = "PetNamingRemotes"


local UserNamedPet = Instance.new("RemoteEvent", Remotes)
UserNamedPet.Name = "UserNamedPet"
--[[
	RemoteEvent UserNamedPet

	Paramaters: petName (string)

	To be fired by the client when the user has picked a name for their pet.

	Example:

	local userNamedPet = ReplicatedStorage:WaitForChild("PetNamingRemotes"):WaitForChild("UserNamedPet")
	userNamedPet:FireServer("Max")
]]

local SendPetName = Instance.new("RemoteEvent", Remotes)
SendPetName.Name = "SendPetName"
--[[
	RemoteEvent SendPetName

	Paramaters: userId (int), petName (string)

	Fired by the server when a user changes their pet's name

	Example:

	local sendPetName = ReplicatedStorage:WaitForChild("PetNamingRemotes"):WaitForChild("SendPetName")
	sendPetName.OnClientEvent:Connect(function(userId, petName)
		local player = Players:GetPlayerByUserId(userId)
		if player then
			print(player.Name.." has named their pet ".. petName)
		end	
	end)
]]

local RequestAllPetNames = Instance.new("RemoteFunction", Remotes)
RequestAllPetNames.Name = "RequestAllPetNames"
--[[
	RemoteEvent SendPetName

	Paramaters: n/a

	Fetches the names of every player's pet. To be invoked by the client when a user joins the game. 

	Example:

	local requestAllPetNames = ReplicatedStorage:WaitForChild("PetNamingRemotes"):WaitForChild("RequestAllPetNames")
	local petNames = requestAllPetNames:InvokeServer()
	for userId, petName in pairs(petNames or {}) do
		local player = Players:GetPlayerByUserId(userId)
		if player then
			print(player.Name.." has a pet named ".. petName)
		end	
	end

]]

local filterResults = {}

local function broadcastPetName(userId)
	local filterResult = filterResults[userId]
	if filterResult then
		for _, player in pairs(Players:GetPlayers()) do 
			if player then

				-- spawn a new thread so as to not yield the update
				spawn(function()

					-- grab the filtered string for this user
					local toUserId = player.UserId
					local filteredString = filterResult:GetNonChatStringForUserAsync(toUserId)
					filteredString = filteredString or ""
					-- send the remote event
					SendPetName:FireClient(player, userId, filteredString)
				end)
			end
		end
	end
end

UserNamedPet.OnServerEvent:Connect(function(player, petName)
	local fromUserId = player.UserId

	-- pcall to catch errors
	local success, result = pcall(function()
		return TextService:FilterStringAsync(
			petName, 
			fromUserId
		)
	end)

	if success then
		filterResults[fromUserId] = result
		broadcastPetName(fromUserId)
	else
		print("Could not filter pet name")
	end
end)

RequestAllPetNames.OnServerInvoke = (function(player)
	local toUserId = player.UserId

	local petNames = {}

	-- go through filter results and filter the pet name to be sent
	for fromUserId, filterResult in pairs(filterResults) do
		local filteredString = filterResult:GetNonChatStringForUserAsync(toUserId)
		filteredString = filteredString or ""

		-- need to convert userId to string so it can't be sent via a remote function
		petNames[tostring(fromUserId)] = filteredString
	end

	return petNames
end)

-- Listen for players being removed, and clean up old filter results
Players.PlayerRemoving:Connect(function(oldPlayer)
	local userId = oldPlayer.UserId
	filterResults[userId] = nil
end)