Signal Since 1.0.0 ​

The Signal object is used to emit events and listen for them.

Functions ​

new Since 1.0.0 ​

Creates a new signal.

<T...>() -> Signal<T...>

local Signal = Signal.new()

Methods ​

Connect Since 1.0.0 ​

Connects a function to the signal.

(
	Callback: (T...) -> () -- The function to connect.
) -> (() -> ())

This connects the callback to the signal. This can be disconnected by calling the returned function.

local Disconnect = Signal:Connect(function()
	print("Hello, world!")
end)

Fire Since 1.0.0 ​

Fires the signal.

(
	...: T... -- The values to pass to the callbacks.
) -> ()

This calls all the callbacks connected to the signal with the values passed to this function.

Signal:Fire("Hello, world!")

Wait Since 1.0.0 ​

Waits for the signal to fire.

() -> Promise

This returns a promise that resolves when the signal fires.

Signal:Wait():Then(function()
	print("Hello, world!")
end)

DisconnectAll Since 1.0.0 ​

Disconnects all the callbacks from the signal.

() -> ()