threejs-worldgen
    Preparing search index...

    Interface SplashOptions

    Settings of a SplashEmitter. Plain JSON.

    interface SplashOptions {
        center: [number, number];
        material: string;
        maxPerFrame: number;
        particles: [number, number];
        puddleDepth: number;
        radius: number;
        rain: number;
        retireOutside: boolean;
        seed: string | number;
        soak: number;
        speed: number;
        splashes: number;
    }
    Index
    center: [number, number]

    Centre of the splash area, world x and z.

    material: string

    Material of the splash particles (one of the solver's).

    maxPerFrame: number

    Most splashes per update (the rest of that frame's are dropped).

    particles: [number, number]

    Particles per splash: on dry ground (a low scatter of droplets) and on a puddle (a crown plus a central jet).

    puddleDepth: number

    Puddle depth from which a drop splashes as onto water, metres.

    radius: number

    Splashes land within this radius of center, metres (e.g. the near field around the camera).

    rain: number

    Rain rate, mm/h (0: no rain; puddles drain and dry).

    retireOutside: boolean

    Also remove any particle that leaves the solver's domain (a stream running off its side), instead of freezing it.

    seed: string | number

    Seed of the impact positions and splash shapes.

    soak: number

    Also remove stray water: a particle on its own (grid mass at its node below this many full cells of 1000 kg/m³) resting on the ground soaks in, instead of lying there as a 15 mL bead. 0: off.

    speed: number

    Launch speed of the splash droplets, m/s (a crown on water; dry-ground droplets fly lower and wider).

    splashes: number

    MPM splashes per m² per second per mm/h of rain: the few visible splashes among the real drop impacts (~70 per m²·s per mm/h).