Skip to main content

RideSeatUtil

Utility functions for the RideSeatPlugin

Properties​

trainModelUtil​

</>
RideSeatUtil.trainModelUtil: RideSeatTrainModelUtil

Utility functions for TrainModels for the RideSeatPlugin

Functions​

getSeatInstances​

</>
RideSeatUtil.getSeatInstances(instance: Instance) → {Seat}

Gets only Seat instance descendants from the given Instance

getTagged​

</>
RideSeatUtil.getTagged(tag: string) → (model: Model) → {Instance}

Creates a function which gets descendants from a given Instance tagged with the given tag name.

Show raw api
{
    "functions": [
        {
            "name": "getSeatInstances",
            "desc": "Gets only Seat instance descendants from the given Instance",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Seat}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 6,
                "path": "src/shared/plugins/rideSeat/shared/seatUtil/getSeatInstances.lua"
            }
        },
        {
            "name": "getTagged",
            "desc": "Creates a function which gets descendants from a given Instance tagged with the given tag name.",
            "params": [
                {
                    "name": "tag",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(model: Model) -> {Instance}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 8,
                "path": "src/shared/plugins/rideSeat/shared/seatUtil/getTagged.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "trainModelUtil",
            "desc": "Utility functions for TrainModels for the RideSeatPlugin",
            "lua_type": "RideSeatTrainModelUtil",
            "source": {
                "line": 8,
                "path": "src/shared/plugins/rideSeat/shared/seatUtil/init.lua"
            }
        }
    ],
    "types": [],
    "name": "RideSeatUtil",
    "desc": "Utility functions for the RideSeatPlugin",
    "source": {
        "line": 3,
        "path": "src/shared/plugins/rideSeat/shared/seatUtil/init.lua"
    }
}