threejs-worldgen
    Preparing search index...

    Interface OverlayOptions

    Every overlay setting (plain data). Change at runtime with PopulationOverlay.set.

    interface OverlayOptions {
        autoDistance: number;
        coarsest: number;
        extrude: number;
        gap: number;
        mode: PopulationMode;
        networkOffset: number;
        networks: boolean;
        offset: number;
        opacity: number;
        origin: Vec3;
        resolution: number | "auto";
        style: PopulationStyle;
        visible: boolean;
    }
    Index
    autoDistance: number

    'auto': stay at the finest resolution until the camera is this many fine-cell edges away.

    coarsest: number

    'auto': at most this many resolutions coarser than the data.

    extrude: number

    Prism height at the top of the ramp, metres (0 = flat, ground-draped tiles).

    gap: number

    0…0.5: shrink each hexagon towards its centre, leaving a gap between cells.

    What cells are coloured (and extruded) by.

    networkOffset: number

    Lift of network lines above the ground, metres.

    networks: boolean

    Draw roads, rails and power lines.

    offset: number

    Lift above the ground, metres.

    opacity: number

    0…1 opacity.

    origin: Vec3

    Floating origin: the world position at render-space zero (as in WorldTerrain).

    resolution: number | "auto"

    H3 resolution to draw, or 'auto' to step coarser as the camera pulls away.

    Colours.

    visible: boolean

    Show the overlay.