Skip to main content

SignalConnection

The connection class used by Signal objects.

Properties​

Connected​

</>
SignalConnection.Connected: boolean

If the SignalConnection is connected to a Signal, this value will be true, otherwise false.

Functions​

Disconnect​

</>
SignalConnection:Disconnect() → ()

Disconnects the connection, removing it from the Signal it is connected to.

Show raw api
{
    "functions": [
        {
            "name": "Disconnect",
            "desc": "Disconnects the connection, removing it from the [Signal] it is connected to.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 182,
                "path": "src/Util/Signal.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Connected",
            "desc": "If the [SignalConnection] is connected to a [Signal], this value will be `true`, otherwise `false`.",
            "lua_type": "boolean",
            "source": {
                "line": 22,
                "path": "src/Util/Signal.luau"
            }
        }
    ],
    "types": [],
    "name": "SignalConnection",
    "desc": "The connection class used by [Signal] objects.",
    "source": {
        "line": 16,
        "path": "src/Util/Signal.luau"
    }
}