Skip to main content

SeatWrapper_Client

Properties​

onLocalPlayerSeated​

Signal
</>
SeatWrapper_Client.onLocalPlayerSeated: Signal<() → ()>

Fires when the LocalPlayer's character sits in this seat on the ride.

onLocalPlayerUnseated​

Signal
</>
SeatWrapper_Client.onLocalPlayerUnseated: Signal<() → ()>

Fires when the LocalPlayer's character jumps out of this seat on the ride.

Functions​

new​

Constructor
</>
SeatWrapper_Client.new(seat: Seat) → ()

Destroy​

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

isLocalPlayerSeated​

</>
SeatWrapper_Client:isLocalPlayerSeated() → boolean

Returns true if LocalPlayer is seated in this seat

setLockOccupant​

</>
SeatWrapper_Client:setLockOccupant(newValue: boolean) → ()

Sets whether player can jump out of this seat

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "Seat"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 44,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 86,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        },
        {
            "name": "isLocalPlayerSeated",
            "desc": "Returns true if LocalPlayer is seated in this seat",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 96,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        },
        {
            "name": "setLockOccupant",
            "desc": "Sets whether player can jump out of this seat",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 102,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "onLocalPlayerSeated",
            "desc": "Fires when the LocalPlayer's character sits in this seat on the ride.",
            "lua_type": "Signal<() -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 33,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        },
        {
            "name": "onLocalPlayerUnseated",
            "desc": "Fires when the LocalPlayer's character jumps out of this seat on the ride.",
            "lua_type": "Signal<() -> ()>",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 38,
                "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
            }
        }
    ],
    "types": [],
    "name": "SeatWrapper_Client",
    "desc": "",
    "source": {
        "line": 28,
        "path": "src/shared/plugins/rideSeat/client/SeatWrapper.lua"
    }
}