Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ChatWindowMessageProperties

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

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 6

HistoryMember
644FontFace: Font
644PrefixTextProperties: ChatWindowMessageProperties
644TextColor3: Color3
644TextSize: int
644TextStrokeColor3: Color3
644TextStrokeTransparency: double
inherited from TextChatMessageProperties
513PrefixText: string
513Text: string
595Translation: string
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

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

History 7

Members 6

FontFace

TypeDefault
Font

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

PrefixTextProperties

TypeDefault
ChatWindowMessageProperties

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

TextColor3

TypeDefault
Color31, 1, 1

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

TextSize

TypeDefault
int18

Determines the size of the text in the chat window.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

TextStrokeColor3

TypeDefault
Color30, 0, 0

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

TextStrokeTransparency

TypeDefault
double0.5

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 1

Settings