Skip to main content

CustomSeatModuleClient

Client Module for the CustomSeatPlugin

Properties​

SeatManager_Client​

</>
CustomSeatModuleClient.SeatManager_Client: SeatManager_Client

CustomSeat_Client​

</>
CustomSeatModuleClient.CustomSeat_Client: CustomSeat_Client

CustomSeatWrapper_Client​

</>
CustomSeatModuleClient.CustomSeatWrapper_Client: CustomSeatWrapper_Client

Functions​

removeCharacter​

</>
CustomSeatModuleClient.removeCharacter(
userId: number,
model: Model
) → ()

Handles removing of a character if not the LocalPlayer or in-game Player's character

jumpOutOfSeatManager​

</>
CustomSeatModuleClient.jumpOutOfSeatManager(seatManager: SeatManager_Client) → ()

Handles player leave request when they jump.

usePlayerCharacter​

</>
CustomSeatModuleClient.usePlayerCharacter(createCharacter: (userId: number) → Model) → (userId: number) → Model

Handles creation of a character by using the in-game Player's character. Otherwise uses the createCharacter function passed into it's argument.

touchSeatManager​

</>
CustomSeatModuleClient.touchSeatManager(seatManager: SeatManager_Client) → ()

Handles player sit request when they touch a seat. Seat must be a BasePart.

Show raw api
{
    "functions": [
        {
            "name": "removeCharacter",
            "desc": "Handles removing of a character if not the LocalPlayer or in-game Player's character",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 9,
                "path": "src/shared/plugins/customSeat/client/removeCharacter.lua"
            }
        },
        {
            "name": "jumpOutOfSeatManager",
            "desc": "Handles player leave request when they jump.",
            "params": [
                {
                    "name": "seatManager",
                    "desc": "",
                    "lua_type": "SeatManager_Client"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 7,
                "path": "src/shared/plugins/customSeat/client/jumpOutOfSeatManager.lua"
            }
        },
        {
            "name": "usePlayerCharacter",
            "desc": "Handles creation of a character by using the in-game Player's character.\nOtherwise uses the createCharacter function passed into it's argument.",
            "params": [
                {
                    "name": "createCharacter",
                    "desc": "",
                    "lua_type": "(userId: number) -> Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(userId: number) -> Model"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 10,
                "path": "src/shared/plugins/customSeat/client/usePlayerCharacter.lua"
            }
        },
        {
            "name": "touchSeatManager",
            "desc": "Handles player sit request when they touch a seat.\nSeat must be a BasePart.",
            "params": [
                {
                    "name": "seatManager",
                    "desc": "",
                    "lua_type": "SeatManager_Client"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 9,
                "path": "src/shared/plugins/customSeat/client/touchSeatManager.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "SeatManager_Client",
            "desc": "",
            "lua_type": "SeatManager_Client",
            "source": {
                "line": 7,
                "path": "src/shared/plugins/customSeat/client/init.lua"
            }
        },
        {
            "name": "CustomSeat_Client",
            "desc": "",
            "lua_type": "CustomSeat_Client",
            "source": {
                "line": 11,
                "path": "src/shared/plugins/customSeat/client/init.lua"
            }
        },
        {
            "name": "CustomSeatWrapper_Client",
            "desc": "",
            "lua_type": "CustomSeatWrapper_Client",
            "source": {
                "line": 15,
                "path": "src/shared/plugins/customSeat/client/init.lua"
            }
        }
    ],
    "types": [],
    "name": "CustomSeatModuleClient",
    "desc": "Client Module for the CustomSeatPlugin",
    "source": {
        "line": 3,
        "path": "src/shared/plugins/customSeat/client/init.lua"
    }
}