Skip to main content

viewportFrameUtil

A simple utility for working with ViewportFrame.

Credits to EgoMoose for some of the math related operations.

Functions​

renderModel​

</>
viewportFrameUtil.renderModel(
viewportFrame: ViewportFrame,
model: Model,
data: {
cameraFieldOfView: number,
rotationSpeed: number?
}?
) → ()

Renders the given model in the viewport frame. Returns a trove.

Show raw api
{
    "functions": [
        {
            "name": "renderModel",
            "desc": " \nRenders the given model in the viewport frame. Returns a trove.",
            "params": [
                {
                    "name": "viewportFrame",
                    "desc": "",
                    "lua_type": "ViewportFrame"
                },
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "{ cameraFieldOfView: number, rotationSpeed: number? }?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/viewportFrameUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "viewportFrameUtil",
    "desc": "A simple utility for working with [ViewportFrame](https://create.roblox.com/docs/reference/engine/classes/ViewportFrame).\n\n*Credits to EgoMoose for some of the math related operations.*",
    "source": {
        "line": 8,
        "path": "src/viewportFrameUtil/init.luau"
    }
}