RealSignal.Connect

Connects a callback to a RealSignal and returns a RealSignalConnection. The callback receives the arguments passed to Fire.

Syntax

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

Arguments

Name	Type	Required	Description
`signal`	`RealSignal`	Yes	Signal object returned by Signal.new.
`callback`	`(....any) -> ()`	Yes	Function called whenever the signal is fired while the connection remains connected.

Returns

Name	Type	Description
`connection`	`RealSignalConnection`	Connection object with Disconnect.

Types

RealSignal

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.

RealSignalConnection

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

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

Example

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()

⌘I

Overview

Cache

Cryptography

Filesystem

JSON

Console

Drawing

ImGui

Input

Instances

Reflection

Scripts

Signals

WebSocket

Actors

Closures

Debug

Environment

Metatables

Threads

Disassembler

Miscellaneous

RakNet

RealSignal

SaveInstance

Syntax

Arguments

Returns

Types

RealSignal

RealSignalConnection

Example

​Syntax

​Arguments

​Returns

​Types

​RealSignal

​RealSignalConnection

​Example

Syntax

Arguments

Returns

Types

RealSignal

RealSignalConnection

Example