The `Datatype.RBXScriptSignal` data type, more commonly known as an **Event**,
provides a way for user-defined functions, called **listeners**, to call when
something happens in the game. When an event happens, the
`Datatype.RBXScriptSignal` fires and calls any listeners that are connected to
it. An `Datatype.RBXScriptSignal` may also pass arguments to each listener to
provide extra information about the event. For more information about events,
see [Events](/scripting/events).


Establishes a function to be called when the event fires. Returns a
`Datatype.RBXScriptConnection` object associated with the connection.


RBXScriptSignal:Connect

func

Connects the given function to the event and returns an
`Datatype.RBXScriptConnection` that represents it.


Establishes a function to be called when the event fires. Returns a
`Datatype.RBXScriptConnection` object associated with the connection. When
the event fires, the signal callback is executed in a desynchronized
state. Using `ConnectParallel` is similar to, but more efficient than,
using `Connect` followed by a call to `Library.task.desynchronize()` in
the signal handler.

Note: Scripts that connect in parallel must be rooted under an Actor.


RBXScriptSignal:ConnectParallel

Establishes a function to be called when the event fires. Returns a
`Datatype.RBXScriptConnection` object associated with the connection. The
behavior of `Once` is similar to `Connect`. However, instead of allowing
multiple events to be received by the specified function, only the first
event will be delivered. Using `Once` also ensures that the connection to
the function will be automatically disconnected prior the function being
called.


RBXScriptSignal:Once

Connects the given function to the event (for a single invocation) and
returns an `Datatype.RBXScriptConnection` that represents it.


Yields the current thread until the signal fires and returns the arguments
provided by the signal.


RBXScriptSignal:Wait

RBXScriptSignal

An object that runs connected functions upon a specific occurrence.


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}

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.

RBXScriptSignal

Methods

Methods

Connect

Parameters

Returns

ConnectParallel

Parameters

Returns

Once

Parameters

Returns

Wait

Returns