threejs-worldgen
    Preparing search index...

    Interface HydrologyOptions

    Settings of analyzeHydrology.

    interface HydrologyOptions {
        bankFalloff: number;
        depthFactor: number;
        epsilon: number;
        fill: number;
        maxWidth: number;
        minDepth: number;
        minLakeArea: number;
        minLakeDepth: number;
        minWidth: number;
        riverArea: number;
        seaLevel: number;
        smoothing: number;
        widthExponent: number;
        widthFactor: number;
    }
    Index
    bankFalloff: number

    Bank slope width as a multiple of the channel half-width (the carving modifier's falloff).

    depthFactor: number

    Channel depth as a fraction of its width.

    epsilon: number

    Height (metres) added per cell across filled flats so every cell drains (Priority-Flood+ε).

    fill: number

    0 … 1: how full channels are (the water surface sits this far from the bed to the bank top).

    maxWidth: number

    Widest river, metres.

    minDepth: number

    Shallowest channel, metres.

    minLakeArea: number

    Smallest lake kept, m².

    minLakeDepth: number

    Shallowest lake kept (its deepest point), metres.

    minWidth: number

    Narrowest river, metres.

    riverArea: number

    Upstream area (m²) at which a channel becomes a river.

    seaLevel: number

    Cells at or below this height are sea: they absorb flow and are never filled. -Infinity = only the map edges drain.

    smoothing: number

    Smoothing passes over river polylines (removes the D8 zig-zag).

    widthExponent: number

    Width grows as (area / 1 km²)^widthExponent; 0.5 is typical of real rivers.

    widthFactor: number

    River width (metres) where it drains 1 km².