RealSignal.Connect - Real Function Reference

RealSignal.Connect(signal: RealSignal, callback: (....any) -> ()): RealSignalConnection

Arguments

RealSignal

requis

Signal object returned by Signal.new.

(....any) -> ()

requis

Function called whenever the signal is fired while the connection remains connected.

RealSignalConnection

Connection object with Disconnect.

Signal object returned by Signal.new.

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

Connection object returned by RealSignal.Connect and RealSignal.Once.

Name	Type	Required	Description
`Disconnect`	`() -> ()`	Yes	Disconnects the connection.

Connect a callback and disconnect it when it is no longer needed.

local signal = Signal.new()

local connection = signal:Connect(function(value)
    print(value)
end)

signal:Fire(1)
connection:Disconnect()