Called when `Class.TextChannel` is receiving an incoming message. Can only
be implemented on the client.

Use this to decorate `Class.TextChatMessage`s. If this callback returns a
`Class.TextChatMessageProperties`, those properties are merged with the
`Class.TextChatMessage` parameter to create a new `Class.TextChatMessage`
with those properties.

When bound to the client sending a message, this event can be fired twice,
first when the message is initially sent and received by the same client
locally, and then when the client receives the result of the filtered
message from the server. `Class.TextChannel.OnIncomingMessage` callbacks
always run **after** `Class.TextChatService.OnIncomingMessage` callback.

This should be defined only once per TextChannel in the source code.
Multiple bindings to the same TextChannel will override one another in a
nondeterministic manner.


TextChannel.OnIncomingMessage

message

If a `Class.TextChatMessageProperties` is returned, those properties
are merged with the `Class.TextChatMessage` parameter to create a new
`Class.TextChatMessage` with those properties.


Called when `Class.TextChannel` is receiving an incoming message.


Called when `Class.TextChannel` is receiving an incoming message to
determine whether or not to deliver the message to other clients. Can only
be defined on the server.

Once defined, this callback needs to return a truthy value (true, 1,
"hello") to deliver the message to other clients. If the callback returns
anything else (including nil), the message can't be delivered. The sender
will still see the message even if the message can't be delivered.


TextChannel.ShouldDeliverCallback

textSource

Called when `Class.TextChannel` is receiving an incoming message to
determine whether or not it should be delivered to other clients.


TextChannel.MessageReceived

incomingMessage

TextChannel:DisplaySystemMessage

systemMessage

metadata

TextChannel:AddUserAsync

userId

TextChannel:SendAsync

TextChannel

The below example would print "Part is now a child of Model".


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

This code first references an existing object in the `original` variable.
Then, it makes a copy of the object, sets the parent to that of the original,
and finally moves the copy to (0, 50, 0).


Instance:Clone

Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Instance:GetPropertyChangedSignal

Instance:IsA

Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.DataCost

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.SourceAssetId

Instance.archivable

Instance.className

Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

Unable to add to inventory

The code sample {title} has been added to your Inventory.

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

TextChannel

Summary

Properties

Methods

Events

Callbacks

Properties

Methods

DisplaySystemMessage

Parameters

Returns

AddUserAsync

Parameters

Returns

SendAsync

Parameters

Returns

Events

MessageReceived

Parameters

Callbacks

OnIncomingMessage

Parameters

Returns

ShouldDeliverCallback

Parameters

Returns