Skip to main content

Signal

A lightweight typed signal for event handling.

Functions​

new​

</>
Signal.new() → Signal

Creates a new Signal instance.

connect​

</>
Signal:connect(
callback: function--

The callback to invoke when the signal fires

) → Connection--

A connection that can be disconnected

Connects a callback to this signal.

fire​

</>
Signal:fire(
...: any--

Arguments to pass to all connected callbacks

) → ()

Fires the signal with the given arguments.

destroyAllConnections​

</>
Signal:destroyAllConnections() → ()

Disconnects all callbacks from this signal.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new Signal instance.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Signal"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/Signal.luau"
            }
        },
        {
            "name": "connect",
            "desc": "Connects a callback to this signal.",
            "params": [
                {
                    "name": "callback",
                    "desc": "The callback to invoke when the signal fires",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "A connection that can be disconnected",
                    "lua_type": "Connection"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 32,
                "path": "src/Signal.luau"
            }
        },
        {
            "name": "fire",
            "desc": "Fires the signal with the given arguments.",
            "params": [
                {
                    "name": "...",
                    "desc": "Arguments to pass to all connected callbacks",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/Signal.luau"
            }
        },
        {
            "name": "destroyAllConnections",
            "desc": "Disconnects all callbacks from this signal.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/Signal.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Signal",
    "desc": "A lightweight typed signal for event handling.",
    "source": {
        "line": 5,
        "path": "src/Signal.luau"
    }
}