Skip to main content

CustomSeatWrapper_Client

Extends CustomSeat Description here

Functions​

new​

Constructor
</>
CustomSeatWrapper_Client.new(seat: CustomSeat_Client) → CustomSeatWrapper_Client

isLocalPlayerSeated​

</>
CustomSeatWrapper_Client:isLocalPlayerSeated() → boolean

Returns true if LocalPlayer is seated in this seat

setLockOccupant​

</>
CustomSeatWrapper_Client:setLockOccupant(newValue: boolean) → ()

Sets whether player can jump out of this seat

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "CustomSeat_Client"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomSeatWrapper_Client"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 22,
                "path": "src/shared/plugins/customSeat/client/CustomSeatWrapper.lua"
            }
        },
        {
            "name": "isLocalPlayerSeated",
            "desc": "Returns true if LocalPlayer is seated in this seat",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 48,
                "path": "src/shared/plugins/customSeat/client/CustomSeatWrapper.lua"
            }
        },
        {
            "name": "setLockOccupant",
            "desc": "Sets whether player can jump out of this seat",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/shared/plugins/customSeat/client/CustomSeatWrapper.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CustomSeatWrapper_Client",
    "desc": "Extends CustomSeat\n*Description here*",
    "source": {
        "line": 14,
        "path": "src/shared/plugins/customSeat/client/CustomSeatWrapper.lua"
    }
}