Actors

get_comm_channel

Returns the communication event for a channel id.

Syntax

get_comm_channel(channelId: integer): Instance | nil

Arguments

NameTypeDescription
channelIdintegerCommunication channel identifier returned by create_comm_channel.

Returns

NameTypeDescription
eventInstance | nilBindable event used by the communication channel.

Description

Returns the communication event for a channel id.

Call it with 1 parameter(s): channelId. The argument table explains which values are required and which ones only refine the behavior.

It returns event (Instance | nil). Use the returns table to separate successful values from nil results and recoverable errors.

Example

Example call with placeholder values.

local result = get_comm_channel(1)
print(result)