Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TextChatMessageProperties

Overrides TextChatMessage properties when returned by callbacks defined in TextChatService.OnIncomingMessage or TextChannel.OnIncomingMessage.

Memory categoryInstances

Member index 3

HistoryMember
513PrefixText: string
513Text: string
595Translation: string
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
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

Overrides TextChatMessage properties when returned by callbacks defined in TextChatService.OnIncomingMessage or TextChannel.OnIncomingMessage. This can be used to customize the appearance of a message with rich text tags.

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

local TextChatService = game:GetService("TextChatService")

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

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

	-- Set chat window message properties
  message.ChatWindowMessageProperties = properties

  return properties
end

History 4

Members 3

PrefixText

TypeDefault
string

The TextChatMessage.PrefixText to override.

Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 1

Text

TypeDefault
string

The TextChatMessage.Text to override.

Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 1

Translation

TypeDefault
string

The TextChatMessage.Translation to override; represents automatically translated and filtered text messages based on players' localization settings.

Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 1

Settings