Skip to main content

SeatManager_Server

Extends SeatManager Description here

Properties​

serverData​

</>
SeatManager_Server.serverData: Folder

The Folder which holds Instances to sync between server and client. Please remember to parent it somewhere client-visible after SeatManager_Server has been created.

Functions​

new​

Constructor
</>
SeatManager_Server.new() → SeatManager_Server

ready​

</>
SeatManager_Server:ready() → ()

Readies this SeatManager so that clients can sync. Please remember to call this so that players can setup their seats. Otherwise yields their calling.

isPlayerSeated​

</>
SeatManager_Server:isPlayerSeated(player: Player) → boolean

Returns true if the given player is seated in a seat managed by this SeatManager

add​

</>
SeatManager_Server:add(seatId: string) → CustomSeat_Server--

The created seat

Registers a given seat

Errors

TypeDescription
"Seat already registered with name ${seatId}"

update​

</>
SeatManager_Server:update() → ()

Updates this SeatManager. Must be called in a loop.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SeatManager_Server"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 29,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Readies this SeatManager so that clients can sync.\nPlease remember to call this so that players can setup their seats.\nOtherwise yields their calling.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        },
        {
            "name": "isPlayerSeated",
            "desc": "Returns true if the given player is seated in a seat managed by this SeatManager",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        },
        {
            "name": "_add",
            "desc": "Registers a seat to this SeatManager_Server",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "CustomSeat_Server"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 107,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        },
        {
            "name": "add",
            "desc": "Registers a given seat",
            "params": [
                {
                    "name": "seatId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "The created seat",
                    "lua_type": "CustomSeat_Server"
                }
            ],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "\"Seat already registered with name ${seatId}\"",
                    "desc": ""
                }
            ],
            "source": {
                "line": 135,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates this SeatManager.\nMust be called in a loop.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 147,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "serverData",
            "desc": "The Folder which holds Instances to sync between server and client.\nPlease remember to parent it somewhere client-visible after SeatManager_Server has been created.",
            "lua_type": "Folder",
            "source": {
                "line": 21,
                "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
            }
        }
    ],
    "types": [],
    "name": "SeatManager_Server",
    "desc": "Extends SeatManager\n*Description here*",
    "source": {
        "line": 16,
        "path": "src/shared/plugins/customSeat/server/SeatManager.lua"
    }
}