Signal

core

A typed observer for game events. Create one with Signal.new, connect listeners with Signal:Connect, and notify them with Signal:Fire.

This module is written as a realistic Roblox-style library so Fumablox can show off inferred members, Luau types, and mixed handwritten docs.

Source

../examples/library/src/Signal.luau:1

Properties

Constructors

new

constructor

function Signal.new(debugName: string?): Signal

Creates a new signal.

Parameters

Returns

../examples/library/src/Signal.luau:33

Methods

Connect

function Signal:Connect(listener: Listener): Connection

Connects listener and returns a Connection.

Parameters

Returns

../examples/library/src/Signal.luau:48

Destroy

since v2

function Signal:Destroy()

Destroys the signal and disconnects listeners.

../examples/library/src/Signal.luau:89

DisconnectAll

function Signal:DisconnectAll()

Disconnects every listener.

../examples/library/src/Signal.luau:81

Fire

function Signal:Fire(...: any)

Fires the signal with the given arguments.

Parameters

Example: Fire a score update

signal:Fire(player, 10)

../examples/library/src/Signal.luau:62

Wait

yields

function Signal:Wait(): ...any

Yields until the next fire.

Returns

../examples/library/src/Signal.luau:71

Types

Connection

A handle returned by Signal:Connect.

../examples/library/src/Signal.luau:15

Listener

type Listener = (...any) -> ()

A callback invoked when the signal fires.

../examples/library/src/Signal.luau:24