Skip to main content

RideSeatPlugin

Manages seats for a ModelAnimationPlayer

Properties​

onOccupantChanged​

Signal
</>
RideSeatPlugin.onOccupantChanged: Signal<(player: Player | nil) → ()>

Fires when the current occupant changes. Passes the current value of currentOccupant.

onPlayerSeated​

Signal
</>
RideSeatPlugin.onPlayerSeated: Signal<(player: Player) → ()>

Fires when a Player's character sits in this seat on the ride. Passes the Player who sat in this seat.

onPlayerUnseated​

Signal
</>
RideSeatPlugin.onPlayerUnseated: Signal<(player: Player) → ()>

Fires when a Player's character jumps out of this seat on the ride. Passes the Player who left this seat.

onOccupantChanged​

Signal
</>
RideSeatPlugin.onOccupantChanged: Signal<(player: Player | nil) → ()>

Fires when the current occupant changes. Passes the current value of currentOccupant.

onPlayerSeated​

Signal
</>
RideSeatPlugin.onPlayerSeated: Signal<(player: Player) → ()>

Fires when a Player's character sits in this seat on the ride. Passes the Player who sat in this seat.

onPlayerUnseated​

Signal
</>
RideSeatPlugin.onPlayerUnseated: Signal<(player: Player) → ()>

Fires when a Player's character jumps out of this seat on the ride. Passes the Player who left this seat.

onPlayerSeated​

Signal
</>
RideSeatPlugin.onPlayerSeated: Signal<(
player: Player,
rideSeat: RideSeat
) → ()>

Fires when a Player's character sits in a seat on the ride. Passes the Player and the RideSeat for the seat where the player has sit in.

onPlayerUnseated​

Signal
</>
RideSeatPlugin.onPlayerUnseated: Signal<(
player: Player,
rideSeat: RideSeat
) → ()>

Fires when a Player's character jumps out of a seat on the ride. Passes the Player and the RideSeat for the seat where the player had sat.

Functions​

new​

Constructor
</>
RideSeatPlugin.new(
animPlayer: ModelAnimationPlayer,
getSeatsFromModel: (model: Model) → Result
) → RideSeatPlugin

setSeatsDisabledFromList​

Static
</>
RideSeatPlugin.setSeatsDisabledFromList(
seats: {RideSeat},
newValue: boolean
) → ()

Calls setDisabled of all rideSeats in the list with the value

Destroy​

Deconstructor
</>
RideSeatPlugin:Destroy() → ()

getSeat​

</>
RideSeatPlugin:getSeat(seat: any) → RideSeat

getSeatedPlayers​

</>
RideSeatPlugin:getSeatedPlayers() → {Player}

Returns an "immutable" list of current seated players

setSeatsDisabled​

</>
RideSeatPlugin:setSeatsDisabled(newValue: boolean) → ()

Sets the .Disabled value of all seats in this plugin

enableSeats​

</>
RideSeatPlugin:enableSeats() → ()

Enables all seats in this plugin

disableSeats​

</>
RideSeatPlugin:disableSeats() → ()

Disables all seats in this plugin. Will also kick players out of their seats

disableOpenSeats​

</>
RideSeatPlugin:disableOpenSeats() → ()

Disables all seats which do not have an occupant

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "animPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer"
                },
                {
                    "name": "getSeatsFromModel",
                    "desc": "",
                    "lua_type": "(model: Model) -> Result"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideSeatPlugin"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 30,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 63,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "_setModel",
            "desc": "Fired when ModelAnimationPlayer's AnimationModel is set",
            "params": [
                {
                    "name": "animModel",
                    "desc": "",
                    "lua_type": "AnimationModel"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "Unable to get seats from train model",
                    "desc": ""
                }
            ],
            "private": true,
            "source": {
                "line": 70,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "_removeModel",
            "desc": "Fired when ModelAnimationPlayer's AnimationModel is changing",
            "params": [
                {
                    "name": "_animModel",
                    "desc": "",
                    "lua_type": "AnimationModel"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 98,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "getSeat",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideSeat"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 109,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "getSeatedPlayers",
            "desc": "Returns an \"immutable\" list of current seated players",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Player}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 115,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "_add",
            "desc": "Adds a seat to this plugin",
            "params": [
                {
                    "name": "rideSeat",
                    "desc": "",
                    "lua_type": "RideSeat.RideSeat"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 131,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "_remove",
            "desc": "",
            "params": [
                {
                    "name": "rideSeat",
                    "desc": "",
                    "lua_type": "RideSeat"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 159,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "setSeatsDisabledFromList",
            "desc": "Calls setDisabled of all rideSeats in the list with the value",
            "params": [
                {
                    "name": "seats",
                    "desc": "",
                    "lua_type": "{RideSeat}"
                },
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Static"
            ],
            "source": {
                "line": 183,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "setSeatsDisabled",
            "desc": "Sets the .Disabled value of all seats in this plugin",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 194,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "enableSeats",
            "desc": "Enables all seats in this plugin",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 201,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "disableSeats",
            "desc": "Disables all seats in this plugin. Will also kick players out of their seats",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 206,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "disableOpenSeats",
            "desc": "Disables all seats which do not have an occupant",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 211,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "onOccupantChanged",
            "desc": "Fires when the current occupant changes.\nPasses the current value of `currentOccupant`.",
            "lua_type": "Signal<(player: Player | nil) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 33,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "onPlayerSeated",
            "desc": "Fires when a Player's character sits in this seat on the ride.\nPasses the Player who sat in this seat.",
            "lua_type": "Signal<(player: Player) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 39,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "onPlayerUnseated",
            "desc": "Fires when a Player's character jumps out of this seat on the ride.\nPasses the Player who left this seat.",
            "lua_type": "Signal<(player: Player) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 45,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "onOccupantChanged",
            "desc": "Fires when the current occupant changes.\nPasses the current value of `currentOccupant`.",
            "lua_type": "Signal<(player: Player | nil) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 36,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "onPlayerSeated",
            "desc": "Fires when a Player's character sits in this seat on the ride.\nPasses the Player who sat in this seat.",
            "lua_type": "Signal<(player: Player) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 42,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "onPlayerUnseated",
            "desc": "Fires when a Player's character jumps out of this seat on the ride.\nPasses the Player who left this seat.",
            "lua_type": "Signal<(player: Player) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 48,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "onPlayerSeated",
            "desc": "Fires when a Player's character sits in a seat on the ride.\nPasses the Player and the RideSeat for the seat where the player has sit in.",
            "lua_type": "Signal<(player: Player, rideSeat: RideSeat) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 17,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        },
        {
            "name": "onPlayerUnseated",
            "desc": "Fires when a Player's character jumps out of a seat on the ride.\nPasses the Player and the RideSeat for the seat where the player had sat.",
            "lua_type": "Signal<(player: Player, rideSeat: RideSeat) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 23,
                "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
            }
        }
    ],
    "types": [],
    "name": "RideSeatPlugin",
    "desc": "Manages seats for a ModelAnimationPlayer",
    "source": {
        "line": 11,
        "path": "src/shared/plugins/rideSeat/shared/RideSeatPlugin.lua"
    }
}