Skip to main content

CameraFrame

Represents a camera state at a certain point. Can perform math on this state.

Properties​

CFrame​

</>
CameraFrame.CFrame: CFrame

Position​

</>
CameraFrame.Position: Vector3

FieldOfView​

</>
CameraFrame.FieldOfView: number

QFrame​

</>
CameraFrame.QFrame: QFrame

QFrame​

</>
CameraFrame.QFrame: QFrame

Functions​

new​

</>
CameraFrame.new(
qFrame: QFrame,
fieldOfView: number
) → CameraFrame

Constructs a new CameraFrame

isCameraFrame​

</>
CameraFrame.isCameraFrame(value: any) → boolean

Returns whether a value is a CameraFrame

__add​

</>
CameraFrame.__add(
) → CameraFrame

Linearly adds the camera frames together.

__sub​

</>
CameraFrame.__sub(
) → CameraFrame

Linearly subtractions the camera frames together.

__unm​

</>
CameraFrame.__unm(a: CameraFrame) → CameraFrame

Inverts the QFrame and the field of view.

__mul​

</>
CameraFrame.__mul(
a: CameraFrame | number,
b: CameraFrame | number
) → CameraFrame

Multiplies the camera frame with the given value

__div​

</>
CameraFrame.__div(
b: number
) → CameraFrame

Divides the camera frame by the value

__pow​

</>
CameraFrame.__pow(
b: number
) → CameraFrame

Takes the camera frame to the Nth power

__eq​

</>
CameraFrame.__eq(
) → boolean

Compares the camera frame to make sure they're equal

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new CameraFrame",
            "params": [
                {
                    "name": "qFrame",
                    "desc": "",
                    "lua_type": "QFrame"
                },
                {
                    "name": "fieldOfView",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "isCameraFrame",
            "desc": "Returns whether a value is a CameraFrame",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__add",
            "desc": "Linearly adds the camera frames together.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 112,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__sub",
            "desc": "Linearly subtractions the camera frames together.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__unm",
            "desc": "Inverts the QFrame and the field of view.",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 137,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__mul",
            "desc": "Multiplies the camera frame with the given value",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame | number"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "CameraFrame | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__div",
            "desc": "Divides the camera frame by the value",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 165,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__pow",
            "desc": "Takes the camera frame to the Nth power",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 179,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "__eq",
            "desc": "Compares the camera frame to make sure they're equal",
            "params": [
                {
                    "name": "a",
                    "desc": "",
                    "lua_type": "CameraFrame"
                },
                {
                    "name": "b",
                    "desc": "",
                    "lua_type": "CameraFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 193,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "CFrame",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 43,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "Position",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 48,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "FieldOfView",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 53,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "QFrame",
            "desc": "",
            "lua_type": "QFrame",
            "source": {
                "line": 58,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        },
        {
            "name": "QFrame",
            "desc": "",
            "lua_type": "QFrame",
            "source": {
                "line": 63,
                "path": "src/camera/src/Client/Utility/CameraFrame.lua"
            }
        }
    ],
    "types": [],
    "name": "CameraFrame",
    "desc": "Represents a camera state at a certain point. Can perform math on this state.",
    "source": {
        "line": 5,
        "path": "src/camera/src/Client/Utility/CameraFrame.lua"
    }
}