Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ChatWindowMessageProperties

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

Member index 6

HistoryMember
726FontFace: Font
726PrefixTextProperties: ChatWindowMessageProperties
726TextColor3: Color3
726TextSize: int
726TextStrokeColor3: Color3
726TextStrokeTransparency: double
inherited from TextChatMessageProperties
513PrefixText: string
513Text: string
595Translation: string
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(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 13

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 2

PrefixTextProperties

TypeDefault
ChatWindowMessageProperties

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 2

TextColor3

TypeDefault
Color3

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 2

TextSize

TypeDefault
int

Determines the size of the text in the chat window.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 2

TextStrokeColor3

TypeDefault
Color3

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 2

TextStrokeTransparency

TypeDefault
double

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedfalse

History 2

Settings