Skip to main content

SummedCamera

Add two cameras together

Functions​

new​

</>
SummedCamera.new(
cameraA: CameraEffect,--

A CameraState or another CameraEffect to be used

cameraB: CameraEffect--

A CameraState or another CameraEffect to be used

) → SummedCamera

Construct a new summed camera

SetMode​

</>
SummedCamera.SetMode(
self: SummedCamera,
mode: "World" | "Relative"--

Mode to set

) → SummedCamera

Sets the summation mode. If "World", then it just adds positions. If "Relative", then it moves position relative to cameraA's CFrame.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Construct a new summed camera",
            "params": [
                {
                    "name": "cameraA",
                    "desc": "A CameraState or another CameraEffect to be used",
                    "lua_type": "CameraEffect"
                },
                {
                    "name": "cameraB",
                    "desc": "A CameraState or another CameraEffect to be used",
                    "lua_type": "CameraEffect"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SummedCamera"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/camera/src/Client/Effects/SummedCamera.lua"
            }
        },
        {
            "name": "SetMode",
            "desc": "Sets the summation mode. If \"World\", then it just adds positions.\nIf \"Relative\", then it moves position relative to cameraA's CFrame.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SummedCamera"
                },
                {
                    "name": "mode",
                    "desc": "Mode to set",
                    "lua_type": "\"World\" | \"Relative\""
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SummedCamera"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/camera/src/Client/Effects/SummedCamera.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SummedCamera",
    "desc": "Add two cameras together",
    "source": {
        "line": 6,
        "path": "src/camera/src/Client/Effects/SummedCamera.lua"
    }
}