Skip to main content

RideSeatPlugin_Client

Manages seats for a ModelAnimationPlayer client-side

Properties​

onLocalPlayerSeated​

Signal
</>
RideSeatPlugin_Client.onLocalPlayerSeated: Signal<(seatWrapper: SeatWrapper) → ()>

Fires when the LocalPlayer's character sits in a seat on the ride. Passes the SeatWrapper for the seat where the player has sit in.

onLocalPlayerUnseated​

Signal
</>
RideSeatPlugin_Client.onLocalPlayerUnseated: Signal<(seatWrapper: SeatWrapper) → ()>

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

Functions​

new​

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

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

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RideSeatPlugin_Client.\nPlugin will also be added to the ModelAnimationPlayer.",
            "params": [
                {
                    "name": "animPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Client"
                },
                {
                    "name": "getSeatsFromModel",
                    "desc": "",
                    "lua_type": "(model: Model) -> Result"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideSeatPlugin_Client"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 35,
                "path": "src/shared/plugins/rideSeat/client/RideSeatPlugin.lua"
            }
        },
        {
            "name": "_add",
            "desc": "",
            "params": [
                {
                    "name": "seatWrapper",
                    "desc": "",
                    "lua_type": "SeatWrapper_Client"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 58,
                "path": "src/shared/plugins/rideSeat/client/RideSeatPlugin.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "onLocalPlayerSeated",
            "desc": "Fires when the LocalPlayer's character sits in a seat on the ride.\nPasses the SeatWrapper for the seat where the player has sit in.",
            "lua_type": "Signal<(seatWrapper: SeatWrapper) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 19,
                "path": "src/shared/plugins/rideSeat/client/RideSeatPlugin.lua"
            }
        },
        {
            "name": "onLocalPlayerUnseated",
            "desc": "Fires when the LocalPlayer's character jumps out of a seat on the ride.\nPasses the SeatWrapper for the seat where the player had sat.",
            "lua_type": "Signal<(seatWrapper: SeatWrapper) -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 25,
                "path": "src/shared/plugins/rideSeat/client/RideSeatPlugin.lua"
            }
        }
    ],
    "types": [],
    "name": "RideSeatPlugin_Client",
    "desc": "Manages seats for a ModelAnimationPlayer client-side",
    "source": {
        "line": 13,
        "path": "src/shared/plugins/rideSeat/client/RideSeatPlugin.lua"
    }
}