Skip to main content

Connection

A simple class for mimicking RBXConnection objects.

Properties​

Connected​

Connection Instance
</>
Connection.Connected: boolean

Functions​

new​

</>
Connection.new(cleanupCallback: () → ()) → Connection

Types

​

type Connection = Connection

Creates and returns a new connection object.

Disconnect​

</>
Connection:Disconnect() → ()

Disconnects the connection and renders it unusuable.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates and returns a new connection object.",
            "params": [
                {
                    "name": "cleanupCallback",
                    "desc": "",
                    "lua_type": "() -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/Connection/init.luau"
            }
        },
        {
            "name": "Disconnect",
            "desc": "Disconnects the connection *and renders it unusuable*.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 38,
                "path": "src/Connection/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Connected",
            "desc": "",
            "lua_type": "boolean",
            "tags": [
                "Connection Instance"
            ],
            "source": {
                "line": 12,
                "path": "src/Connection/init.luau"
            }
        }
    ],
    "types": [
        {
            "name": "Connection",
            "desc": "",
            "lua_type": "Connection",
            "source": {
                "line": 17,
                "path": "src/Connection/init.luau"
            }
        }
    ],
    "name": "Connection",
    "desc": "A simple class for mimicking [RBXConnection](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection) objects.",
    "source": {
        "line": 6,
        "path": "src/Connection/init.luau"
    }
}