Skip to main content

CustomSeatWrapper_Server

Extends CustomSeatWrapper Description here

Functions​

new​

Constructor
</>
CustomSeatWrapper_Server.new(seat: CustomSeat_Server) → CustomSeatWrapper_Server

setOccupantLocked​

</>
CustomSeatWrapper_Server:setOccupantLocked(newValue: boolean) → ()

Sets whether any players seated in this seat can jump out

lockOccupant​

</>
CustomSeatWrapper_Server:lockOccupant() → ()

Prevents any players seated in this seat from jumping out

unlockOccupant​

</>
CustomSeatWrapper_Server:unlockOccupant() → ()

Allows any players seated in this seat to jump out

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "CustomSeat_Server"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomSeatWrapper_Server"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 15,
                "path": "src/shared/plugins/customSeat/server/CustomSeatWrapper.lua"
            }
        },
        {
            "name": "setOccupantLocked",
            "desc": "Sets whether any players seated in this seat can jump out",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 23,
                "path": "src/shared/plugins/customSeat/server/CustomSeatWrapper.lua"
            }
        },
        {
            "name": "lockOccupant",
            "desc": "Prevents any players seated in this seat from jumping out",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/shared/plugins/customSeat/server/CustomSeatWrapper.lua"
            }
        },
        {
            "name": "unlockOccupant",
            "desc": "Allows any players seated in this seat to jump out",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 35,
                "path": "src/shared/plugins/customSeat/server/CustomSeatWrapper.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CustomSeatWrapper_Server",
    "desc": "Extends CustomSeatWrapper\n*Description here*",
    "source": {
        "line": 7,
        "path": "src/shared/plugins/customSeat/server/CustomSeatWrapper.lua"
    }
}