Skip to main content

ReconnectionPolicy

Used to handle player reconnections

Functions​

new​

</>
ReconnectionPolicy.new(
name: string,
handler: (
context: Context,
player: Player,
previousState: PlayerState
) → ()
) → ReconnectionPolicy

Constructor method for a new reconnection policy

Resolve​

</>
ReconnectionPolicy.Resolve(nameOrInstance: string | ReconnectionPolicy) → ReconnectionPolicy

Resolves a reconnection policy instance from its name

Handle​

</>
ReconnectionPolicy:Handle(
ctx: Context,
player: Player,
previousState: PlayerState
) → ()

Handles the reconnection policy for a player

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor method for a new reconnection policy",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "handler",
                    "desc": "",
                    "lua_type": "(context: Context, player: Player, previousState: PlayerState) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ReconnectionPolicy"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "src/Classes/ReconnectionPolicy.lua"
            }
        },
        {
            "name": "Handle",
            "desc": "Handles the reconnection policy for a player",
            "params": [
                {
                    "name": "ctx",
                    "desc": "",
                    "lua_type": "Context"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "previousState",
                    "desc": "",
                    "lua_type": "PlayerState"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 24,
                "path": "src/Classes/ReconnectionPolicy.lua"
            }
        },
        {
            "name": "Resolve",
            "desc": "Resolves a reconnection policy instance from its name",
            "params": [
                {
                    "name": "nameOrInstance",
                    "desc": "",
                    "lua_type": "string | ReconnectionPolicy"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ReconnectionPolicy"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 31,
                "path": "src/Classes/ReconnectionPolicy.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ReconnectionPolicy",
    "desc": "Used to handle player reconnections",
    "source": {
        "line": 3,
        "path": "src/Classes/ReconnectionPolicy.lua"
    }
}