Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface VFXShakeData

    interface VFXShakeData {
        duration: number;
        maxDisplacement: number;
        returnSpeed: number;
        seed: number | null;
        smoothness: number;
        target: string;
    }
    Index

    Properties

    duration: number

    The active shake duration in milliseconds (default 5000)

    maxDisplacement: number

    The maximum displacement in pixels at the start of the shake (default 35)

    returnSpeed: number

    The return-to-origin interpolation factor per tick in [0, 1] (default 0.1)

    seed: number | null

    An optional seed for a deterministic, reproducible shake pattern (default null)

    smoothness: number

    Shake smoothness in [0, 1]; higher values produce lower-frequency motion (default 0.5)

    target: string

    The canvas property key of the display object to shake (default "stage")