Skip to main content

PlayerStateRegistry

Used to store player states for the round

Functions​

new​

</>
PlayerStateRegistry.new() → PlayerStateRegistry

Constructor method for a new player state registry

AddPlayerState​

</>
PlayerStateRegistry:AddPlayerState(player: Player) → PlayerRoundState

Adds a new player state to the registry

RemovePlayerState​

</>
PlayerStateRegistry:RemovePlayerState(userId: number) → ()

Removes a player state from the registry

GetPlayerState​

</>
PlayerStateRegistry:GetPlayerState(userId: number) → PlayerRoundState?

Gets a player state from the registry

GetAllPlayerStates​

</>
PlayerStateRegistry:GetAllPlayerStates() → table-Atablecontainingallplayerroundstateinstances

Gets all player states from the registry

Clear​

</>
PlayerStateRegistry:Clear() → ()

Clears all player states from the registry

Destroy​

</>
PlayerStateRegistry:Destroy() → ()

Destroys the player state registry

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor method for a new player state registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerStateRegistry"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 10,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "AddPlayerState",
            "desc": "Adds a new player state to the registry",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerRoundState"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 19,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "RemovePlayerState",
            "desc": "Removes a player state from the registry",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 28,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "GetPlayerState",
            "desc": "Gets a player state from the registry",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerRoundState?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 39,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "GetAllPlayerStates",
            "desc": "Gets all player states from the registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table - A table containing all player round state instances"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "Clear",
            "desc": "Clears all player states from the registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the player state registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/Registries/PlayerStateRegistry.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerStateRegistry",
    "desc": "Used to store player states for the round",
    "source": {
        "line": 5,
        "path": "src/Registries/PlayerStateRegistry.lua"
    }
}