GSmGpE6CwX2y9JjB25B8
We use cookies on this site to enhance your user experience
Collapse Sidebar

Chat

Show Show deprecated

Chat

Show deprecated

The Chat service is a special service that houses the Lua code responsible for running the Lua Chat System. Similar to StarterPlayerScripts, default objects (Scripts, ModuleScripts and other objects) are inserted into the Chat service. Individual objects may be overridden by providing objects with the same name as those inserted. The following objects are guaranteed to exist inside of the Chat service, and can be overridden:

The contents of the Chat service which are loaded when the game runs.

Text Filtering

In addition to housing the Lua Chat System, the Chat service also exposes functions used to filter text - Chat/FilterStringAsync|FilterStringAsync and Chat/FilterStringForBroadcast|FilterStringForBroadcast. Chat filtering is built into the Lua Chat System already, but games that implement custom chat systems must use these functions to filter chat properly. For more information, see Text and Chat Filtering.

Properties

bool

BubbleChatEnabled

bool

LoadDefaultChat

Toggles whether the default chat framework should be automatically loaded when the game runs.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

bool

CanUserChatAsync ( int64 userId )

[Yields]

Will return false if the player with the specified Player/UserId is not allowed to chat because of their account settings.

bool

CanUsersChatAsync ( int64 userIdFrom , int64 userIdTo )

[Yields]

Will return false if the two users cannot communicate because their account settings do not allow it.

void

Chat ( Instance partOrCharacter , string message , ChatColor color )

Fires the Chat/Chatted event with the parameters specified in this method.

string

FilterStringAsync ( string stringToFilter , Instance playerFrom , Instance playerTo )

[Yields]

Filters a string being sent to playerTo from playerFrom with filtering that is appropriate to the given player’s account settings.

string

FilterStringForBroadcast ( string stringToFilter , Instance playerFrom )

[Yields]

Filters a string sent from a player meant for broadcast to no particular target. More restrictive than /Chat/FilterStringAsync.

string

FilterStringForPlayerAsync ( string stringToFilter , Instance playerToFilterFor )

[Yields] [Deprecated]

Filters a string appropriate to the given player’s age settings, so they see what is appropriate to them.

void

RegisterChatCallback ( ChatCallbackType callbackType , Function callbackFunction )

Register a function to be called upon the invocation of some chat system event (Chat/InvokeChatCallback|InvokeChatCallback)

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

Chatted ( Instance part , string message , ChatColor color )

Fires when Chat/Chat is called.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]