hex-world
    Preparing search index...

    Interface RiverGeneratorOptions

    interface RiverGeneratorOptions {
        gridSpacing?: number;
        minSeedElevation?: number;
        maxSteps?: number;
        waterTerrainIndex?: number;
        orientation?: HexOrientation;
    }
    Index

    Properties

    gridSpacing?: number

    Coarse grid spacing in cells between river seed candidates. Default 48.

    minSeedElevation?: number

    Minimum elevation for a cell to seed a river. Default 5.

    maxSteps?: number

    Maximum steps a traced river will take. Default 60.

    waterTerrainIndex?: number

    Terrain index assigned to lake cells. Default 5 (built-in Water).

    orientation?: HexOrientation

    Hex orientation providing the edge-index → direction mapping. Must match the layout used for rendering or river edges point at the wrong neighbors. Default POINTY_TOP.