Skip to main content

RideSeatPlugin_Server

Manages seats for a ModelAnimationPlayer server-side

Functions​

new​

Constructor
</>
RideSeatPlugin_Server.new(
getSeatsFromModel: (model: Model) → Result
) → RideSeatPlugin_Server

Constructs a new RideSeatPlugin_Server. Plugin will also be added to the ModelAnimationPlayer.

setOccupantsLockedFromList​

Static
</>
RideSeatPlugin_Server.setOccupantsLockedFromList(
newValue: boolean
) → ()

setOccupantsLocked​

</>
RideSeatPlugin_Server:setOccupantsLocked(newValue: boolean) → ()

Sets whether seats will lock their occupant

lockOccupants​

</>
RideSeatPlugin_Server:lockOccupants() → ()

Locks all seated occupants in their seats and prevents them from jumping out

unlockOccupants​

</>
RideSeatPlugin_Server:unlockOccupants() → ()

Allows seated players to jump out of their seats

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RideSeatPlugin_Server.\nPlugin will also be added to the ModelAnimationPlayer.",
            "params": [
                {
                    "name": "animPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Server"
                },
                {
                    "name": "getSeatsFromModel",
                    "desc": "",
                    "lua_type": "(model: Model) -> Result"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideSeatPlugin_Server"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 18,
                "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
            }
        },
        {
            "name": "setOccupantsLockedFromList",
            "desc": "",
            "params": [
                {
                    "name": "seats",
                    "desc": "",
                    "lua_type": "{SeatWrapper_Server}"
                },
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Static"
            ],
            "source": {
                "line": 34,
                "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
            }
        },
        {
            "name": "setOccupantsLocked",
            "desc": "Sets whether seats will lock their occupant",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
            }
        },
        {
            "name": "lockOccupants",
            "desc": "Locks all seated occupants in their seats and prevents them from jumping out",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
            }
        },
        {
            "name": "unlockOccupants",
            "desc": "Allows seated players to jump out of their seats",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RideSeatPlugin_Server",
    "desc": "Manages seats for a ModelAnimationPlayer server-side",
    "source": {
        "line": 8,
        "path": "src/shared/plugins/rideSeat/server/RideSeatPlugin.lua"
    }
}