Documentation
    Preparing search index...

    Interface CameraShakeOptions

    Options for CameraShake (§44).

    interface CameraShakeOptions {
        amplitude?: Vector3;
        frequency?: number;
        rotationAmplitude?: Vector3;
        seed?: number | SeededRandom;
        trauma?: number;
        traumaDecay?: number;
    }
    Index
    amplitude? frequency? rotationAmplitude? seed? trauma? traumaDecay?
    amplitude?: Vector3

    Peak positional offset, in metres (§7a). Copied. Default (1, 1, 1).

    frequency?: number

    Value-noise frequency in hertz. The lattice coordinate is simulationTime · frequency, so the waveform is a function of simulation time, not of step count. Finite and >= 0. Default 1.

    rotationAmplitude?: Vector3

    Peak rotational offset, in radians about world +X/+Y/+Z. Copied. Default (0, 0, 0) — position-only shake.

    seed?: number | SeededRandom

    Hash salt. A SeededRandom contributes its seed only — the stream is not advanced. Default 0.

    trauma?: number

    Initial trauma in [0, 1]. Default 1 (full amplitude, no impulse required).

    traumaDecay?: number

    Trauma drop per second. Finite and >= 0. Default 0 (no decay).

    Settings
    Member Visibility

    On This Page
    Properties