Skip to main content

SeatManager

Description here

Functions​

new​

Constructor
</>
SeatManager.new() → SeatManager

Destroy​

Deconstructor
</>
SeatManager:Destroy() → ()

contains​

</>
SeatManager:contains(seatId: string) → boolean

Returns true if there is a seat in this SeatManager with the given id

get​

</>
SeatManager:get(seatId: string) → CustomSeat

Gets the seat in this SeatManager with the given id.

getAmount​

</>
SeatManager:getAmount() → number

Returns the amount of seats managed my this

isSeated​

</>
SeatManager:isSeated(occupant: any) → ()

Returns true if the given occupant

getOccupantSeat​

</>
SeatManager:getOccupantSeat(occupant: any) → CustomSeat

Gets the seat the given occupant is in.

add​

</>
SeatManager:add(_seatId: string) → ()

Adds a seat to this SeatManager

Errors

TypeDescription
Not implemented!

_add​

</>
SeatManager:_add(
seatId: string,
seat: CustomSeat.CustomSeat
) → ()

Registers a given seat

remove​

</>
SeatManager:remove(seatId: string) → boolean

Registers a given seat

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SeatManager"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 18,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 39,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "contains",
            "desc": "Returns true if there is a seat in this SeatManager with the given id",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 46,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "get",
            "desc": "Gets the seat in this SeatManager with the given id.",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomSeat"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "getAmount",
            "desc": "Returns the amount of seats managed my this",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 58,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "isSeated",
            "desc": "Returns true if the given occupant",
            "params": [
                {
                    "name": "occupant",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "getOccupantSeat",
            "desc": "Gets the seat the given occupant is in.",
            "params": [
                {
                    "name": "occupant",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomSeat"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "add",
            "desc": "Adds a seat to this SeatManager",
            "params": [
                {
                    "name": "_seatId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "Not implemented!",
                    "desc": ""
                }
            ],
            "source": {
                "line": 89,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "_add",
            "desc": "Registers a given seat",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "CustomSeat.CustomSeat"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 94,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        },
        {
            "name": "remove",
            "desc": "Registers a given seat",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 113,
                "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SeatManager",
    "desc": "*Description here*",
    "source": {
        "line": 11,
        "path": "src/shared/plugins/customSeat/shared/SeatManager.lua"
    }
}