SetBubbleChatSettings

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Chat

Description:

Note

For a more detailed walkthrough, take a look at the Bubble Chat and Lua Chat System articles.

This function customizes various settings of the in-game bubble chat.

Before using this, make sure that bubble chat is enabled by setting Chat/BubbleChatEnabled to true.

The settings argument is a table where the keys are the names of the settings you want to edit and the values are what you want to change these settings to. Note that you don’t have to include all of them in the settings argument, omitting some will result in them keeping their default value.

This function is client-side only, attempting to call it on the server will trigger an error.

Parameters

Name	Type	Default	Description
Name settings	Type Variant	Default	Summary A settings table. Check `articles/Bubble Chat\|Bubble Chat` for accepted key/value pair

Returns

Return Type	Summary
Return Type void	Summary No return

Code Samples

Customize visual aspects

When run from a LocalScript, this snippet will make all the chat bubbles appear with bigger text under a different font and a light blue background. Note that all the other settings will keep their default value.

			
				Customize visual aspects

				Expected Output
			
				Expand
				
			local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({
	BackgroundColor3 = Color3.fromRGB(180, 210, 228),
	TextSize = 20,
	Font = Enum.Font.Cartoon
})
		
				Copy Code
			
				Light Theme

Restore default settings

If you want to reset the bubble chat to its default look, you can call this function with an empty table, because any setting you omit from the argument will result in it returning to its default value:

			
				Restore default settings

				Expected Output
			
				Expand
				
			local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({})
		
				Copy Code
			
				Light Theme