Syntax
RealSignal.Wait(signal: RealSignal): ....anyArguments
| Name | Type | Description |
|---|---|---|
signal | RealSignal | Signal object returned by Signal.new. |
Returns
| Name | Type | Description |
|---|---|---|
...values | ....any | All values passed to the Fire call that resumed the waiter. |
Description
Yields the current thread until the RealSignal is fired, then resumes with the arguments passed to Fire. It errors when called from a context that cannot yield.
Call it with 1 parameter(s): signal. The argument table explains which values are required and which ones only refine the behavior.
It returns ...values (....any). Use the returns table to separate successful values from nil results and recoverable errors.
Example
Yield until the signal fires and receive the fired values.
local signal = Signal.new()
task.spawn(function()
task.wait(1)
signal:Fire("done", 2)
end)
local status, count = signal:Wait()
print(status, count)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.