Interface ShakeOptions

Configuration options for starting a custom camera shake effect.

interface ShakeOptions {
    callback?: () => void;
    decayCurve?: number;
    duration?: number | { x?: number; y?: number };
    ignoreTimeScale?: boolean;
    infinite?: boolean;
    intensity?: number;
    layers?: number;
    randomInitialAngle?: boolean;
    randomness?: number;
    rotation?: boolean;
    rotationStrength?: number;
    smoothness?: number;
    strength?: number | { x?: number; y?: number };
    timeScale?: number;
    vibrato?: number;
}

Properties

callback? decayCurve? duration? ignoreTimeScale? infinite? intensity? layers? randomInitialAngle? randomness? rotation? rotationStrength? smoothness? strength? timeScale? vibrato?

Properties

Optionalcallback

callback?: () => void

Optional callback function executed when this shake completes.

OptionaldecayCurve

decayCurve?: number

Decay curve factor from 0 (linear) to 1 (exponential) that determines how the shake fades over time.

Optionalduration

duration?: number | { x?: number; y?: number }

The duration of the shake in milliseconds. Can be a number or an object specifying duration for X and Y independently.

OptionalignoreTimeScale

ignoreTimeScale?: boolean

If true, this shake ignores the global timescale and updates at real-time speed.

Optionalinfinite

infinite?: boolean

Whether the shake runs infinitely without automatic completion or decay.

Optionalintensity

intensity?: number

Overall intensity multiplier of this shake (0 to 1).

Optionallayers

layers?: number

The number of oscillation layers (1 to 3) stacked to build complex shake patterns.

OptionalrandomInitialAngle

randomInitialAngle?: boolean

Whether to start the shake rotation with a randomized initial angle.

Optionalrandomness

randomness?: number

Variation in force magnitude between 0 and 1.

Optionalrotation

rotation?: boolean

Whether to enable camera rotation during the shake.

OptionalrotationStrength

rotationStrength?: number

The maximum rotation amplitude of the shake.

Optionalsmoothness

smoothness?: number

Interpolation factor between 0 and 1, where higher values produce smoother transitions between shake forces.

Optionalstrength

strength?: number | { x?: number; y?: number }

The strength (amplitude) of the shake. Can be a single number (applied to both axes) or an object specifying strength for X and Y independently.

OptionaltimeScale

timeScale?: number

Optional per-operation time scale multiplier.

Optionalvibrato

vibrato?: number

The frequency/speed of the shake oscillations in Hz.

Settings

Member Visibility

On This Page

Properties