Skip to main content

ConstrainedLookCamera

Constrains pitch and yaw within a cone.

Functions​

new​

</>
ConstrainedLookCamera.new() → ConstrainedLookCamera

Constructs a new ConstrainedLookCamera.

RotateXY​

</>
ConstrainedLookCamera.RotateXY(
delta: Vector2
) → ()

Rotates the target yaw (X) and pitch (Y) by the given delta, clamped within the max offsets.

Release​

</>
ConstrainedLookCamera.Release(self: ConstrainedLookCamera) → ()

Releases input, sending spring targets back to the origin.

SnapToOrigin​

</>
ConstrainedLookCamera.SnapToOrigin(self: ConstrainedLookCamera) → ()

Snaps springs to the origin without animating.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new ConstrainedLookCamera.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ConstrainedLookCamera\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/camera/src/Client/Effects/ConstrainedLookCamera.lua"
            }
        },
        {
            "name": "RotateXY",
            "desc": "Rotates the target yaw (X) and pitch (Y) by the given delta, clamped within the max offsets.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookCamera"
                },
                {
                    "name": "delta",
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/camera/src/Client/Effects/ConstrainedLookCamera.lua"
            }
        },
        {
            "name": "Release",
            "desc": "Releases input, sending spring targets back to the origin.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookCamera"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/camera/src/Client/Effects/ConstrainedLookCamera.lua"
            }
        },
        {
            "name": "SnapToOrigin",
            "desc": "Snaps springs to the origin without animating.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookCamera"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/camera/src/Client/Effects/ConstrainedLookCamera.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ConstrainedLookCamera",
    "desc": "Constrains pitch and yaw within a cone.",
    "source": {
        "line": 7,
        "path": "src/camera/src/Client/Effects/ConstrainedLookCamera.lua"
    }
}