Skip to main content

ImpulseCamera

Add another layer of effects over any other camera by allowing an "impulse" to be applied. Good for shockwaves, camera shake, and recoil.

Properties​

CameraState​

This item is read only and cannot be modified. Read Only
</>
ImpulseCamera.CameraState: CameraState

The current state.

Functions​

Impulse​

</>
ImpulseCamera.Impulse(
velocity: Vector3,
speed: number?,--

Optional

damper: number?--

Optional

) → ()

Applies an impulse to the camera, shaking it!

ImpulseRandom​

</>
ImpulseCamera.ImpulseRandom(
velocity: Vector3,
speed: number?,--

Optional

damper: number?--

Optional

) → ()

Applies a random impulse

Show raw api
{
    "functions": [
        {
            "name": "Impulse",
            "desc": "Applies an impulse to the camera, shaking it!",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ImpulseCamera"
                },
                {
                    "name": "velocity",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "speed",
                    "desc": "Optional",
                    "lua_type": "number?"
                },
                {
                    "name": "damper",
                    "desc": "Optional",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/camera/src/Client/Effects/ImpulseCamera.lua"
            }
        },
        {
            "name": "ImpulseRandom",
            "desc": "Applies a random impulse",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ImpulseCamera"
                },
                {
                    "name": "velocity",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "speed",
                    "desc": "Optional",
                    "lua_type": "number?"
                },
                {
                    "name": "damper",
                    "desc": "Optional",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "src/camera/src/Client/Effects/ImpulseCamera.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "CameraState",
            "desc": "The current state.",
            "lua_type": "CameraState",
            "readonly": true,
            "source": {
                "line": 149,
                "path": "src/camera/src/Client/Effects/ImpulseCamera.lua"
            }
        }
    ],
    "types": [],
    "name": "ImpulseCamera",
    "desc": "Add another layer of effects over any other camera by allowing an \"impulse\"\nto be applied. Good for shockwaves, camera shake, and recoil.",
    "source": {
        "line": 8,
        "path": "src/camera/src/Client/Effects/ImpulseCamera.lua"
    }
}