@pixi/3d
    Preparing search index...

    Interface ParticleSpawnBuiltInOverrides

    The overrides spawn() takes for the system's own behaviour

    spawn() throws on an override the system wasn't built to take.

    const impact: ParticleSpawnBuiltInOverrides = { position: hit.point, life: [0.2, 0.5], color: 'white' };

    sparks.spawn(12, impact);
    interface ParticleSpawnBuiltInOverrides {
        alpha?: ParticleSpawnValue<number>;
        alphaEnd?: ParticleSpawnValue<number>;
        color?: ColorSource;
        colorEnd?: ColorSource;
        life?: ParticleSpawnValue<number>;
        position?: ParticleSpawnValue<PointData3D>;
        size?: ParticleSpawnValue<number>;
        sizeEnd?: ParticleSpawnValue<number>;
        spin?: ParticleSpawnValue<number>;
        startRotation?: ParticleSpawnValue<number>;
        velocity?: ParticleSpawnValue<PointData3D>;
    }
    Index
    alpha? alphaEnd? color? colorEnd? life? position? size? sizeEnd? spin? startRotation? velocity?
    alpha?: ParticleSpawnValue<number>

    Starting opacity

    smoke.spawn(8, { alpha: [0.3, 0.6] });
    alphaEnd?: ParticleSpawnValue<number>

    End-of-life opacity; only on a system built with alphaEnd

    smoke.spawn(4, { alphaEnd: 0.2 });
    color?: ColorSource

    Starting tint, one for the whole batch: it takes no pair or function

    sparks.spawn(8, { color: 'red' });
    colorEnd?: ColorSource

    End-of-life tint, one for the whole batch; only on a system built with colorEnd

    embers.spawn(8, { colorEnd: 0x330000 });
    life?: ParticleSpawnValue<number>

    Lifetime in seconds

    sparks.spawn(4, { life: [0.5, 1] });
    position?: ParticleSpawnValue<PointData3D>

    Where this batch spawns, in place of the emitter's position

    In a world-space system, the shape's offsets are added unrotated and unscaled, while directions still follow the emitter's rotation.

    dust.spawn(3, { position: { x: wheel.x, y: 0, z: wheel.z } });
    size?: ParticleSpawnValue<number>

    Starting world-space diameter

    sparks.spawn(4, { size: 0.5 });
    sizeEnd?: ParticleSpawnValue<number>

    End-of-life size; only on a system built with sizeEnd

    puffs.spawn(4, { sizeEnd: [2, 3] });
    spin?: ParticleSpawnValue<number>

    Rotation rate in radians per second; only on a system built with spin

    debris.spawn(6, { spin: [-6, 6] });
    startRotation?: ParticleSpawnValue<number>

    Starting spin angle in radians, turning the quad in its own plane

    leaves.spawn(6, { startRotation: (rng: () => number) => rng() * Math.PI });
    velocity?: ParticleSpawnValue<PointData3D>

    Initial velocity, replacing speed along the shape's direction

    sparks.spawn(1, { velocity: { x: 0, y: 6, z: 0 } });

    Settings
    Member Visibility

    On This Page
    Properties