Engine Class
Chat
Summary
Properties
Methods
CanUserChatAsync(userId: number):boolean |
CanUsersChatAsync(userIdFrom: number,userIdTo: number):boolean |
Chat(partOrCharacter: Instance,message: string,color: Enum.ChatColor):() |
FilterStringAsync(stringToFilter: string,playerFrom: Player,playerTo: Player):string |
FilterStringForBroadcast(stringToFilter: string,playerFrom: Player):string |
FilterStringForPlayerAsync(stringToFilter: string,playerToFilterFor: Player):string |
InvokeChatCallback(callbackType: Enum.ChatCallbackType,callbackArguments: Tuple):Tuple |
RegisterChatCallback(callbackType: Enum.ChatCallbackType,callbackFunction: function):() |
SetBubbleChatSettings(settings: Variant):() |
Events
Chatted(part: Instance,message: string,color: Enum.ChatColor):RBXScriptSignal |
API Reference
Properties
Methods
CanUsersChatAsync
Chat
Parameters
| Default Value: "Blue" |
Returns
()
Code Samples
Chat:Chat
local ChatService = game:GetService("Chat")
local part = Instance.new("Part")
part.Anchored = true
part.Parent = workspace
ChatService:Chat(part, "Blame John!", "Red")FilterStringAsync
FilterStringForBroadcast
Returns
Code Samples
Chat:FilterStringForBroadcast
local Players = game:GetService("Players")
local Chat = game:GetService("Chat")
local playerFrom = Players.LocalPlayer
local message = "Hello world!"
-- Filter the string and store the result in the 'FilteredString' variable
local filteredString = Chat:FilterStringForBroadcast(message, playerFrom)
print(filteredString)FilterStringForPlayerAsync
InvokeChatCallback
Parameters
Returns
RegisterChatCallback
Parameters
Returns
()
SetBubbleChatSettings
Chat:SetBubbleChatSettings(settings:Variant):()
Parameters
settings:Variant |
Returns
()
Code Samples
Customize visual aspects
local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({
BackgroundColor3 = Color3.fromRGB(180, 210, 228),
TextSize = 20,
Font = Enum.Font.Cartoon,
})Restore default settings
local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({})Events
Chatted
Parameters