Skip to main content

CustomSeatModule

Module for the CustomSeatPlugin. The CustomSeat modules is a custom implementation of seats designed to support StreamingEnabled.

Properties​

shared​

</>
CustomSeatModule.shared: CustomSeatModuleShared

server​

</>
CustomSeatModule.server: CustomSeatModuleServer

Only visible to server

client​

</>
CustomSeatModule.client: CustomSeatModuleClient

Only visible to client

Functions​

createCharacter​

</>
CustomSeatModule.createCharacter(characterRig: Model) → (userId: number) → Model

Handles creation of a character by using the character appearance of a Player and applying it to the given character rig.

Show raw api
{
    "functions": [
        {
            "name": "createCharacter",
            "desc": "Handles creation of a character by using the character appearance of a Player\nand applying it to the given character rig.",
            "params": [
                {
                    "name": "characterRig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(userId: number) -> Model"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 17,
                "path": "src/shared/plugins/customSeat/shared/createCharacter.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "shared",
            "desc": "",
            "lua_type": "CustomSeatModuleShared",
            "source": {
                "line": 11,
                "path": "src/shared/plugins/customSeat/init.lua"
            }
        },
        {
            "name": "server",
            "desc": "*Only visible to server*",
            "lua_type": "CustomSeatModuleServer",
            "source": {
                "line": 16,
                "path": "src/shared/plugins/customSeat/init.lua"
            }
        },
        {
            "name": "client",
            "desc": "*Only visible to client*",
            "lua_type": "CustomSeatModuleClient",
            "source": {
                "line": 21,
                "path": "src/shared/plugins/customSeat/init.lua"
            }
        }
    ],
    "types": [],
    "name": "CustomSeatModule",
    "desc": "Module for the CustomSeatPlugin.\nThe CustomSeat modules is a custom implementation of seats designed to support StreamingEnabled.",
    "source": {
        "line": 6,
        "path": "src/shared/plugins/customSeat/init.lua"
    }
}