Skip to main content

CameraState

Data container for the state of a camera.

Properties​

cframe​

</>
CameraState.cframe: CFrame

Functions​

new​

</>
CameraState.new(
cameraFrame: CameraFrame | Camera,
cameraFrameDerivative: CameraFrame?
) → CameraState

Constructs a new CameraState

isCameraState​

</>
CameraState.isCameraState(value: any) → boolean

Returns true if the result is a camera state

Set​

</>
CameraState:Set(
camera: Camera--

A CameraState to set, also accepts a Roblox Camera

) → ()

Set another camera state. Typically used to set Workspace.CurrentCamera's state to match this camera's state

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new CameraState",
            "params": [
                {
                    "name": "cameraFrame",
                    "desc": "",
                    "lua_type": "CameraFrame | Camera"
                },
                {
                    "name": "cameraFrameDerivative",
                    "desc": "",
                    "lua_type": "CameraFrame?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraState"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/camera/src/Client/CameraState.lua"
            }
        },
        {
            "name": "isCameraState",
            "desc": "Returns true if the result is a camera state",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/camera/src/Client/CameraState.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Set another camera state. Typically used to set Workspace.CurrentCamera's state to match this camera's state",
            "params": [
                {
                    "name": "camera",
                    "desc": "A CameraState to set, also accepts a Roblox Camera",
                    "lua_type": "Camera"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 91,
                "path": "src/camera/src/Client/CameraState.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "cframe",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 53,
                "path": "src/camera/src/Client/CameraState.lua"
            }
        }
    ],
    "types": [],
    "name": "CameraState",
    "desc": "Data container for the state of a camera.",
    "source": {
        "line": 5,
        "path": "src/camera/src/Client/CameraState.lua"
    }
}