Skip to main content

RideSeat

Base class for a "Seat"

Properties​

seat​

</>
RideSeat.seat: any

currentOccupant​

</>
RideSeat.currentOccupant: Player?

onPlayerSeated​

Signal
</>
RideSeat.onPlayerSeated: Signal

onPlayerUnseated​

Signal
</>
RideSeat.onPlayerUnseated: Signal

maid​

Maid
</>
RideSeat.maid: Maid

Functions​

new​

Constructor
</>
RideSeat.new(seat: any) → RideSeat

Destroy​

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

isOpen​

</>
RideSeat:isOpen() → boolean

Returns true if seat does not have an occupant

isEnabled​

</>
RideSeat:isEnabled() → boolean

Returns true if seat is disabled

setEnabled​

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

Sets Disabled value of the seat

enable​

</>
RideSeat:enable() → ()

Enables this seat

disable​

</>
RideSeat:disable() → ()

Disables this seat this seat

disableIfOpen​

</>
RideSeat:disableIfOpen() → ()

Disables this seat if there are no occupants in it

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideSeat"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 54,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 79,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "isOpen",
            "desc": "Returns true if seat does not have an occupant",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 87,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "isEnabled",
            "desc": "Returns true if seat is disabled",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "setEnabled",
            "desc": "Sets Disabled value of the seat",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 99,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "enable",
            "desc": "Enables this seat",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 106,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "disable",
            "desc": "Disables this seat this seat",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "disableIfOpen",
            "desc": "Disables this seat if there are no occupants in it",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 116,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "seat",
            "desc": "",
            "lua_type": "any",
            "source": {
                "line": 12,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "currentOccupant",
            "desc": "",
            "lua_type": "Player?",
            "source": {
                "line": 15,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "onPlayerSeated",
            "desc": "",
            "lua_type": "Signal",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 19,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "onPlayerUnseated",
            "desc": "",
            "lua_type": "Signal",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 23,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        },
        {
            "name": "maid",
            "desc": "",
            "lua_type": "Maid",
            "tags": [
                "Maid"
            ],
            "source": {
                "line": 27,
                "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
            }
        }
    ],
    "types": [],
    "name": "RideSeat",
    "desc": "Base class for a \"Seat\"",
    "source": {
        "line": 9,
        "path": "src/shared/plugins/rideSeat/shared/RideSeat.lua"
    }
}