Skip to main content

seatUtil

A utility module for working with seats.

Functions​

seatOccupanciesProperty​

</>
seatUtil.seatOccupanciesProperty(seats: {Seat | VehicleSeat}) → Property<{Seat | VehicleSeat}: Player>

Returns a property which is updated based on the Occupant property of the given seats. Also returns a trove object which will cleanup everything.

Show raw api
{
    "functions": [
        {
            "name": "seatOccupanciesProperty",
            "desc": " \nReturns a property which is updated based on the `Occupant` property of the given seats. Also\nreturns a trove object which will cleanup everything.",
            "params": [
                {
                    "name": "seats",
                    "desc": "",
                    "lua_type": "{ Seat | VehicleSeat }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Property<{Seat | VehicleSeat}: Player>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/seatUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "seatUtil",
    "desc": " \n\nA utility module for working with seats.",
    "source": {
        "line": 6,
        "path": "src/seatUtil/init.luau"
    }
}