RealSignal

RealSignal.Fire

Fires the RealSignal with zero or more values.

Syntax

RealSignal.Fire(signal: RealSignal, ...values?: ....any)

Arguments

NameTypeDescription
signalRealSignalSignal object returned by Signal.new.
...values?....anyValues forwarded to connected callbacks and waiting threads.

Description

Fires the RealSignal with zero or more values. Connected callbacks receive those values, once connections are disconnected before invocation, and waiting threads are resumed with the same values. The method returns no values.

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

It does not return data. Treat the call as an action and handle errors around the call site when needed.

Example

Forward values to connected callbacks and waiting threads.

local signal = Signal.new()
local total = 0

signal:Connect(function(value)
    total += value
end)

signal:Fire(5)
print(total)

Types

RealSignal

Signal object returned by Signal.new.

Connect (callback: (...any) -> ()) -> RealSignalConnection Adds a callback that runs when Fire is called.Once (callback: (...any) -> ()) -> RealSignalConnection Adds a callback that is disconnected before its first callback invocation.Wait () -> ...any Yields until Fire resumes the waiter with the fired values.Fire (...values: any) -> () Runs connected callbacks and resumes waiters with the provided values.