threejs-worldgen
    Preparing search index...

    Interface PuddleOptions

    Settings of a PuddleField. Plain JSON.

    interface PuddleOptions {
        cellSize: number;
        dryTime: number;
        evaporation: number;
        flowSpeed: number;
        infiltration: number;
        origin: [number, number];
        resolution: [number, number];
        wetTime: number;
    }
    Index
    cellSize: number

    Cell size, metres. Fixed at construction.

    dryTime: number

    Seconds for a wet surface without standing water to dry (e-folding).

    evaporation: number

    Evaporation, mm/h.

    flowSpeed: number

    How fast water runs off and levels out, m/s (a sheet-flow speed: one cell per cellSize / flowSpeed seconds).

    infiltration: number

    Water soaking into the ground, mm/h.

    origin: [number, number]

    World x, z of the field's minimum corner (cell (i, k) is centred at origin + (i + ½, k + ½)·cellSize).

    resolution: [number, number]

    Cells along x and z. Fixed at construction.

    wetTime: number

    Seconds for a dry surface to get wet under rain (e-folding).