Skip to main content

CameraStoryUtils

Utility functions for hoacekat stories.

Functions​

reflectCamera​

</>
CameraStoryUtils.reflectCamera(
maid: Maid,
topCamera: Camera
) → Camera

Reflects the camera state to the original camera

setupViewportFrame​

</>
CameraStoryUtils.setupViewportFrame(
maid: Maid,
target: GuiBase
) → ViewportFrame

Sets up a viewport frame

promiseCrate​

</>
CameraStoryUtils.promiseCrate(
maid: Maid,
viewportFrame: ViewportFrame,
properties: {[string]}: any}
) → Promise<Instance>

REturns a promise that resolves to a crate in front of the camera.

getInterpolationFactory​

</>
CameraStoryUtils.getInterpolationFactory(
maid: Maid,
viewportFrame: ViewportFrame,
low: number,
high: number,
period: number,
toCFrame: CFrame
) → (
interpolate: function,
color: Color3,
label: string?,
labelOffset: Vector2?
) → ()

Retrieves the interpolation

Show raw api
{
    "functions": [
        {
            "name": "reflectCamera",
            "desc": "Reflects the camera state to the original camera",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "topCamera",
                    "desc": "",
                    "lua_type": "Camera"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Camera"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/camerastoryutils/src/Client/CameraStoryUtils.lua"
            }
        },
        {
            "name": "setupViewportFrame",
            "desc": "Sets up a viewport frame",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "GuiBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ViewportFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/camerastoryutils/src/Client/CameraStoryUtils.lua"
            }
        },
        {
            "name": "promiseCrate",
            "desc": "REturns a promise that resolves to a crate in front of the camera.",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "viewportFrame",
                    "desc": "",
                    "lua_type": "ViewportFrame"
                },
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "{ [string}: any }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Instance>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 70,
                "path": "src/camerastoryutils/src/Client/CameraStoryUtils.lua"
            }
        },
        {
            "name": "getInterpolationFactory",
            "desc": "Retrieves the interpolation",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "viewportFrame",
                    "desc": "",
                    "lua_type": "ViewportFrame"
                },
                {
                    "name": "low",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "high",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "period",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "toCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(interpolate: function, color: Color3, label: string?, labelOffset: Vector2?) -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 114,
                "path": "src/camerastoryutils/src/Client/CameraStoryUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CameraStoryUtils",
    "desc": "Utility functions for hoacekat stories.",
    "source": {
        "line": 5,
        "path": "src/camerastoryutils/src/Client/CameraStoryUtils.lua"
    }
}