Skip to main content

ScriptConnection

A class which holds data and methods for ScriptConnections.

Properties​

Connected​

This item is read only and cannot be modified. Read Only
</>
ScriptConnection.Connected: boolean

A boolean which determines if a ScriptConnection is active or not.

Functions​

Disconnect​

</>
ScriptConnection:Disconnect() → ()

Disconnects a connection, any :Fire calls from now on will not invoke this connection's handler. 

local connection = ScriptSignal:Connect(function() end)

connection.Connected -> true
connection:Disconnect()
connection.Connected -> false
Show raw api
{
    "functions": [
        {
            "name": "Disconnect",
            "desc": "Disconnects a connection, any `:Fire` calls from now on will not\ninvoke this connection's handler.\n\n```lua\nlocal connection = ScriptSignal:Connect(function() end)\n\nconnection.Connected -> true\nconnection:Disconnect()\nconnection.Connected -> false\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 349,
                "path": "src/signal/src/Signal/Deferred.lua"
            }
        },
        {
            "name": "Disconnect",
            "desc": "Disconnects a connection, any `:Fire` calls from now on will not\ninvoke this connection's handler.\n\n```lua\nlocal connection = ScriptSignal:Connect(function() end)\n\nconnection.Connected -> true\nconnection:Disconnect()\nconnection.Connected -> false\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "ignore": true,
            "source": {
                "line": 386,
                "path": "src/signal/src/Signal/Immediate.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Connected",
            "desc": "A boolean which determines if a ScriptConnection is active or not.",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 38,
                "path": "src/signal/src/Signal/Deferred.lua"
            }
        },
        {
            "name": "Connected",
            "desc": "A boolean which determines if a ScriptConnection is active or not.",
            "lua_type": "boolean",
            "readonly": true,
            "ignore": true,
            "source": {
                "line": 30,
                "path": "src/signal/src/Signal/Immediate.lua"
            }
        }
    ],
    "types": [],
    "name": "ScriptConnection",
    "desc": "A class which holds data and methods for ScriptConnections.",
    "source": {
        "line": 14,
        "path": "src/signal/src/Signal/Immediate.lua"
    }
}