Skip to main content

CustomSeat

Extends BaseCustomSeat

Custom seat implementation for a Character-based occupant on a BasePart-based seat.

Properties​

maid​

</>
CustomSeat.maid: Maid

Functions​

new​

Constructor
</>
CustomSeat.new(
seat: BasePart,
getCharacter: GetCharacterFunc
) → CustomSeat

Types

​

type GetCharacterFunc = (
seat: BasePart,
occupant: any,
onRemovingMaid: Maid.Maid
) → nil

_setCurrentOccupant​

overload
</>
CustomSeat:_setCurrentOccupant(
newOccupant: any | nil--

A value used to get the current character; Can be nil

) → ()

Sets the current occupant of this seat

setIsEnabled​

</>
CustomSeat:setIsEnabled(value: boolean) → ()

Sets whether this seat is enabled

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "getCharacter",
                    "desc": "",
                    "lua_type": "GetCharacterFunc"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomSeat"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 31,
                "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
            }
        },
        {
            "name": "_setCurrentOccupant",
            "desc": "Sets the current occupant of this seat",
            "params": [
                {
                    "name": "newOccupant",
                    "desc": "A value used to get the current character; Can be nil",
                    "lua_type": "any | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "overload"
            ],
            "source": {
                "line": 94,
                "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
            }
        },
        {
            "name": "setIsEnabled",
            "desc": "Sets whether this seat is enabled",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "maid",
            "desc": "",
            "lua_type": "Maid",
            "source": {
                "line": 21,
                "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
            }
        }
    ],
    "types": [
        {
            "name": "GetCharacterFunc",
            "desc": "",
            "lua_type": "(seat: BasePart, occupant: any, onRemovingMaid: Maid.Maid) -> nil",
            "source": {
                "line": 12,
                "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
            }
        }
    ],
    "name": "CustomSeat",
    "desc": "#### Extends *BaseCustomSeat*\nCustom seat implementation for a Character-based occupant on a\nBasePart-based seat.",
    "source": {
        "line": 18,
        "path": "src/shared/plugins/customSeat/shared/CustomSeat.lua"
    }
}