Roblox UtilitiesDevlHub Roblox Documentation

Class

ChatWindowMessageProperties

NotCreatable
Memory category
Instances

Customizes the appearance of an individual text chat message displayed in the chat window.

Can be used to customize the appearance of text chat messages sent to the ChatWindow. Inherits from TextChatMessageProperies. To create a new ChatWindowMessageProperties instance, use ChatWindowConfiguration:DeriveNewMessageProperties() which will have the current properties from ChatWindowConfiguration.

Luau
local TextChatService = game:GetService("TextChatService")

local ChatWindowConfiguration = TextChatService:FindFirstChildOfClass("ChatWindowConfiguration")

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
  -- Derive chat message properties
  local properties = ChatWindowConfiguration:DeriveNewMessageProperties()

  -- Change color of message within the chat window
  properties.TextColor3 = Color3.fromRGB(255, 121, 121)

  return properties
end

Properties 6#

FontFaceDatatype.FontFont used to render text in the chat window.ReadSafe
PrefixTextPropertiesChatWindowMessagePropertiesDetermines the properties of the PrefixText preceding the chat message.ReadSafe
TextColor3Color3Color of the text in the chat window.ReadSafe
TextSizeintSize of the text in the chat window.ReadSafe
TextStrokeColor3Color3Stroke color applied to text in the chat window.ReadSafe
TextStrokeTransparencydoubleTransparency of the stroke applied to text in the chat window.ReadSafe

FontFace: Datatype.Font#

ReadSafe

Determines the font used to render text in the chat window. Default is Font.BuilderSansMedium.

PrefixTextProperties: ChatWindowMessageProperties#

ReadSafe

Determines the properties of the TextChatMessage.PrefixText preceding the chat message.

TextColor3: Color3#

ReadSafe

Determines the color of the text in the chat window. Default value is Datatype.Color3.fromRGB(255, 255, 255) (white).

TextSize: int#

ReadSafe

Determines the size of the text in the chat window.

TextStrokeColor3: Color3#

ReadSafe

Determines the stroke color applied to text in the chat window. Default value is Datatype.Color3.fromRGB(0, 0, 0) (black).

TextStrokeTransparency: double#

ReadSafe

Determines the transparency of the stroke applied to text in the chat window. Default value is 0.5.

Inherited members#

Inherited from TextChatMessageProperties 3
Properties (3)

PrefixText, Text, Translation

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed