hex-world
    Preparing search index...

    Interface ClimateRiverOptions

    interface ClimateRiverOptions {
        riverPercentage?: number;
        extraLakeProbability?: number;
        maxSteps?: number;
        elevationMax?: number;
        waterTerrainIndex?: number;
        stopTerrains?: Iterable<number, any, any>;
        orientation?: HexOrientation;
    }
    Index

    Properties

    riverPercentage?: number

    Percentage of land cells that may have rivers (0–20). Default 10.

    extraLakeProbability?: number

    Probability (0–1) of forming a mid-flow lake. Default 0.25.

    maxSteps?: number

    Maximum steps per river trace. Default 100.

    elevationMax?: number

    Maximum land elevation — used for origin weighting. Default 12.

    waterTerrainIndex?: number

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

    stopTerrains?: Iterable<number, any, any>

    Further terrain indices a river ends at on reaching them — other liquids (a lava caldera, an acid pool) that should take a river as an estuary rather than have a channel carved across them. The lake terrain is always a stop. Origins are also kept one cell clear of them.

    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.