Skip to main content

ConstrainedLookControls

Input handler that drives a ConstrainedLookCamera. Reacts to right-click drag on mouse, drag on touchscreen, and right thumbstick on gamepad.

Functions​

new​

</>
ConstrainedLookControls.new(camera: ConstrainedLookCamera.ConstrainedLookCamera) → ConstrainedLookControls

Constructs a new ConstrainedLookControls bound to the given camera.

SetMouseSensitivity​

</>
ConstrainedLookControls.SetMouseSensitivity(
sensitivity: Vector2
) → ()

Sets mouse sensitivity.

SetGamepadSensitivity​

</>
ConstrainedLookControls.SetGamepadSensitivity(
sensitivity: number
) → ()

Sets gamepad sensitivity.

IsEnabled​

</>
ConstrainedLookControls.IsEnabled(self: ConstrainedLookControls) → boolean

Returns whether controls are enabled.

Enable​

</>
ConstrainedLookControls.Enable(self: ConstrainedLookControls) → ()

Enables input. Binds drag (MouseButton2 / Touch) and gamepad Thumbstick2.

Disable​

</>
ConstrainedLookControls.Disable(self: ConstrainedLookControls) → ()

Disables input and releases the camera.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new ConstrainedLookControls bound to the given camera.",
            "params": [
                {
                    "name": "camera",
                    "desc": "",
                    "lua_type": "ConstrainedLookCamera.ConstrainedLookCamera"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ConstrainedLookControls\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        },
        {
            "name": "SetMouseSensitivity",
            "desc": "Sets mouse sensitivity.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookControls"
                },
                {
                    "name": "sensitivity",
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 61,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        },
        {
            "name": "SetGamepadSensitivity",
            "desc": "Sets gamepad sensitivity.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookControls"
                },
                {
                    "name": "sensitivity",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 68,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        },
        {
            "name": "IsEnabled",
            "desc": "Returns whether controls are enabled.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookControls"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        },
        {
            "name": "Enable",
            "desc": "Enables input. Binds drag (MouseButton2 / Touch) and gamepad Thumbstick2.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookControls"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        },
        {
            "name": "Disable",
            "desc": "Disables input and releases the camera.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ConstrainedLookControls"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ConstrainedLookControls",
    "desc": "Input handler that drives a [ConstrainedLookCamera]. Reacts to right-click\ndrag on mouse, drag on touchscreen, and right thumbstick on gamepad.",
    "source": {
        "line": 8,
        "path": "src/camera/src/Client/Controls/ConstrainedLookControls.lua"
    }
}