Skip to main content

SeatWrapper

Extends RideSeat Description here

Properties​

seat​

</>
SeatWrapper.seat: Seat

currentOccupant​

</>
SeatWrapper.currentOccupant: Player?

onPlayerSeated​

Signal
</>
SeatWrapper.onPlayerSeated: Signal

onPlayerUnseated​

Signal
</>
SeatWrapper.onPlayerUnseated: Signal

maid​

Maid
</>
SeatWrapper.maid: Maid

Functions​

new​

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

Destroy​

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

setEnabled​

</>
SeatWrapper:setEnabled(newValue: boolean) → ()

Sets Disabled value of the seat

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "Seat"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SeatWrapper"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 61,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 79,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "_occupantChanged",
            "desc": "Called when occupant changes",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 87,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "setEnabled",
            "desc": "Sets Disabled value of the seat",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "seat",
            "desc": "",
            "lua_type": "Seat",
            "source": {
                "line": 15,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "currentOccupant",
            "desc": "",
            "lua_type": "Player?",
            "source": {
                "line": 18,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "onPlayerSeated",
            "desc": "",
            "lua_type": "Signal",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 22,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "onPlayerUnseated",
            "desc": "",
            "lua_type": "Signal",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 26,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        },
        {
            "name": "maid",
            "desc": "",
            "lua_type": "Maid",
            "tags": [
                "Maid"
            ],
            "source": {
                "line": 30,
                "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
            }
        }
    ],
    "types": [],
    "name": "SeatWrapper",
    "desc": "Extends RideSeat\n*Description here*",
    "source": {
        "line": 52,
        "path": "src/shared/plugins/rideSeat/shared/SeatWrapper.lua"
    }
}