Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Chat

Summary

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 18

HistoryMember
553BubbleChatEnabled: bool
553LoadDefaultChat: bool
462CanUserChatAsync(userId: int64): bool
462CanUsersChatAsync(userIdFrom: int64, userIdTo: int64): bool
573Chat(partOrCharacter: Instance, message: string, color: ChatColor = Blue): null
573ChatLocal(partOrCharacter: Instance, message: string, color: ChatColor = Blue): null
484FilterStringAsync(stringToFilter: string, playerFrom: Player, playerTo: Player): string
484FilterStringForBroadcast(stringToFilter: string, playerFrom: Player): string
553FilterStringForPlayerAsync(stringToFilter: string, playerToFilterFor: Player): string
462GetShouldUseLuaChat(): bool
462InvokeChatCallback(callbackType: ChatCallbackType, callbackArguments: Tuple): Tuple
573RegisterChatCallback(callbackType: ChatCallbackType, callbackFunction: Function): null
573SetBubbleChatSettings(settings: Variant): null
462BubbleChatSettingsChanged(settings: Variant)
462Chatted(part: Instance, message: string, color: ChatColor)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 1

HistoryMember
267SetIsLuaChatBackendOverwritten(value: bool): void

History 55

Members 18

BubbleChatEnabled

TypeDefault
boolfalse

History 4

BubbleChatSettingsChanged

Parameters (1)
settingsVariant

History 2

CanUserChatAsync

Parameters (1)
userIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

CanUsersChatAsync

Parameters (2)
userIdFromint64
userIdToint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

Chat

Parameters (3)Default
partOrCharacterInstance
messagestring
colorChatColorBlue
Returns (1)
null

History 3

ChatLocal

Parameters (3)Default
partOrCharacterInstance
messagestring
colorChatColorBlue
Returns (1)
null

History 3

Chatted

Parameters (3)
partInstance
messagestring
colorChatColor

History 2

FilterStringAsync

Parameters (3)
stringToFilterstring
playerFromPlayer
playerToPlayer
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

FilterStringForBroadcast

Parameters (2)
stringToFilterstring
playerFromPlayer
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

FilterStringForPlayerAsync

Parameters (2)
stringToFilterstring
playerToFilterForPlayer
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. FilterStringAsync should be used instead.
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields, Deprecated]

GetShouldUseLuaChat

Parameters (0)
No parameters.
Returns (1)
bool

History 2

InvokeChatCallback

Parameters (2)
callbackTypeChatCallbackType
callbackArgumentsTuple
Returns (1)
Tuple

History 2

LoadDefaultChat

TypeDefault
booltrue

History 4

RegisterChatCallback

Parameters (2)
callbackTypeChatCallbackType
callbackFunctionFunction
Returns (1)
null

History 3

SetBubbleChatSettings

Parameters (1)
settingsVariant
Returns (1)
null

History 3

Removed members 1

SetIsLuaChatBackendOverwritten

Parameters (1)
valuebool
Returns (1)
void

History 2

Settings