Chat¶
Houses the Luau code responsible for running the legacy chat system.
Description¶
The Chat service houses the Luau code responsible for running the legacy chat system. Similar to StarterPlayerScripts, default objects like Scripts and ModuleScripts are inserted into the service.
Inheritance¶
Nova inheritance: Instance → Chat
Methods¶
Chat Supported Function Fires the Chat.Chatted event with the parameters specified in this method.
The Chat function fires the Chat.Chatted event with the parameters specified in this method.
By default, there is a LocalScript inside of each player's PlayerScripts object named BubbleChat, which causes a dialog-like billboard to appear above the partOrCharacter when the chatted event is fired.
Note: Since dialogs are controlled by a LocalScript, you will not be able to see any dialogs created from this method unless you are running in Play Solo mode.
Roblox reference signature
FilterStringForPlayerAsync Supported Function Deprecated Filters a string appropriate to the given player's age settings, so they see what is appropriate to them.
The FilterStringForPlayerAsync function filters a string appropriate to the given player's age settings, so they see what is appropriate to them. This function will only work if called from a Script on the server. If called on a client it will fail.
Roblox reference signature
Events¶
Chatted Supported Event Fires when Chat.Chat() is called.
Fires when Chat.Chat() is called. The event passes the part or
character the message is associated with, the message string, and the
ChatColor. When fired on the server, the event replicates to all
connected clients. The default BubbleChat LocalScript listens
for this event and displays a chat bubble above the specified part or
character.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
17 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's Chat class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
BubbleChatEnabled |
BubbleChatEnabled: bool |
Not yet | Determines whether player's chat messages will appear above their in-game avatar. | — |
LoadDefaultChat |
LoadDefaultChat: bool |
Not yet | Toggles whether the default chat framework should be automatically loaded when the game runs. | read None / write NotAccessibleSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
CanUserChatAsync |
Chat:CanUserChatAsync(userId: int64): bool |
Not yet | Will return false if the player with the specified Player.UserId is not allowed to chat because of their account settings. | Yields |
CanUsersChatAsync |
Chat:CanUsersChatAsync(userIdFrom: int64, userIdTo: int64): bool |
Not yet | Will return false if the two users cannot communicate because their account settings do not allow it. | Yields |
ChatLocal |
Chat:ChatLocal(partOrCharacter: Instance, message: string, color: ChatColor = Blue): null |
Not yet | — | RobloxScriptSecurity |
FilterStringAsync |
Chat:FilterStringAsync(stringToFilter: string, playerFrom: Player, playerTo: Player): string |
Not yet | Filters a string sent from a player to another player using filtering that is appropriate to the players' account settings. | Yields |
FilterStringForBroadcast |
Chat:FilterStringForBroadcast(stringToFilter: string, playerFrom: Player): string |
Not yet | Filters a string sent from a player meant for broadcast to no particular target. More restrictive than Chat.FilterStringAsync(). | Yields |
GetShouldUseLuaChat |
Chat:GetShouldUseLuaChat(): bool |
Not yet | — | RobloxScriptSecurity |
InvokeChatCallback |
Chat:InvokeChatCallback(callbackType: ChatCallbackType, callbackArguments: Tuple): Tuple |
Not yet | Invoke a chat callback function registered by RegisterChatCallback. Used by the Luau Chat System. | — |
ReconcileCommunicationAccess |
Chat:ReconcileCommunicationAccess(): null |
Not yet | — | RobloxScriptSecurity |
RegisterChatCallback |
Chat:RegisterChatCallback(callbackType: ChatCallbackType, callbackFunction: Function): null |
Not yet | Register a function to be called upon the invocation of some chat system event (InvokeChatCallback). | — |
RequestModerationModeEnabled |
Chat:RequestModerationModeEnabled(enabled: bool): null |
Not yet | — | RobloxScriptSecurity |
SetBubbleChatSettings |
Chat:SetBubbleChatSettings(settings: Variant): null |
Not yet | Customizes various settings of the in-game bubble chat. | — |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
BubbleChatSettingsChanged |
BubbleChatSettingsChanged(settings: Variant) |
Not yet | — | RobloxScriptSecurity |
PlayerChatAvailabilityStatusChanged |
PlayerChatAvailabilityStatusChanged(player: Player) |
Not yet | — | RobloxSecurity |
ReconcileCommunicationAccessCompleted |
ReconcileCommunicationAccessCompleted(chatAvailabilityStatus: string) |
Not yet | — | RobloxScriptSecurity |
TimeoutChatAttempt |
TimeoutChatAttempt(isPermanentTimeout: bool, endTime: int64) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: Chat
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.