@newkrok/three-particles - v2.4.0
    Preparing search index...

    Type Alias Burst

    Defines a burst emission event that emits a specific number of particles at a given time. Bursts are useful for explosions, impacts, fireworks, and other instantaneous particle effects.

    // Simple burst at start
    { time: 0, count: 50 }

    // Random count burst at 1 second
    { time: 1, count: { min: 20, max: 30 } }

    // Repeating burst with interval
    { time: 0.5, count: 10, cycles: 3, interval: 0.2 }
    // Emits at 0.5s, 0.7s, 0.9s

    // Probabilistic burst (50% chance)
    { time: 2, count: 100, probability: 0.5 }
    type Burst = {
        count: Constant | RandomBetweenTwoConstants;
        cycles?: number;
        interval?: number;
        probability?: number;
        time: number;
    }
    Index

    Properties

    count cycles? interval? probability? time

    Properties

    count: Constant | RandomBetweenTwoConstants

    The number of particles to emit. Can be a constant or a random range.

    cycles?: number

    The number of times this burst should repeat. Defaults to 1 (single burst).

    interval?: number

    The time interval (in seconds) between burst cycles. Only used when cycles > 1.

    probability?: number

    The probability (0.0 to 1.0) that this burst will occur. Defaults to 1.0.

    time: number

    The time (in seconds) after the particle system starts when this burst should occur.

    Settings

    Member Visibility

    On This Page

    Properties