Skip to main content

PlayerRoundState

Represents a player's state during a round

Functions​

new​

</>
PlayerRoundState.new(player: Player) → PlayerRoundState

Types

​

interface PlayerRoundState {
Player: (Player),
UserId: (number),
Connected: (boolean),
Ready: (boolean),
Metrics: ({[string]: string | number}),
}

Rebind​

</>
PlayerRoundState:Rebind(newPlayer: Player) → ()

Rebinds the player round state to a new player instance

GetMetric​

</>
PlayerRoundState:GetMetric(key: string) → string | number

Returns the value of a metric for this player

SetMetric​

</>
PlayerRoundState:SetMetric(
key: string,
value: string | number
) → ()

Sets the value of a metric for this player

SetConnected​

</>
PlayerRoundState:SetConnected(connected: boolean) → ()

Sets the connection status of the player

SetReady​

</>
PlayerRoundState:SetReady(ready: boolean) → ()

Sets the ready status of the player

Destroy​

</>
PlayerRoundState:Destroy() → ()

Destroys the player round state instance

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerRoundState"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 8,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "Rebind",
            "desc": "Rebinds the player round state to a new player instance",
            "params": [
                {
                    "name": "newPlayer",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 22,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "GetMetric",
            "desc": "Returns the value of a metric for this player",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "SetMetric",
            "desc": "Sets the value of a metric for this player",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 38,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "SetConnected",
            "desc": "Sets the connection status of the player",
            "params": [
                {
                    "name": "connected",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "SetReady",
            "desc": "Sets the ready status of the player",
            "params": [
                {
                    "name": "ready",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 57,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the player round state instance",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/Classes/PlayerRoundState.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "PlayerRoundState",
            "desc": "",
            "fields": [
                {
                    "name": "Player",
                    "lua_type": "(Player),",
                    "desc": ""
                },
                {
                    "name": "UserId",
                    "lua_type": "(number),",
                    "desc": ""
                },
                {
                    "name": "Connected",
                    "lua_type": "(boolean),",
                    "desc": ""
                },
                {
                    "name": "Ready",
                    "lua_type": "(boolean),",
                    "desc": ""
                },
                {
                    "name": "Metrics",
                    "lua_type": "({ [string]: string | number }),",
                    "desc": ""
                }
            ],
            "source": {
                "line": 10,
                "path": "src/Types/PlayerRoundState.lua"
            }
        }
    ],
    "name": "PlayerRoundState",
    "desc": "Represents a player's state during a round",
    "source": {
        "line": 3,
        "path": "src/Classes/PlayerRoundState.lua"
    }
}