hex-world
    Preparing search index...

    Interface CellOverlayLayerOptions

    interface CellOverlayLayerOptions {
        parent: Object3D;
        layout: HexLayout;
        map: OverlayMapSource | (() => OverlayMapSource);
        isWater?: (terrain: number) => boolean;
        elevationScale?: number;
    }
    Index

    Properties

    parent: Object3D

    Parent to attach overlay meshes to (usually the scene).

    layout: HexLayout

    The map cells are measured against. Pass an accessor if the map instance can be swapped at runtime.

    isWater?: (terrain: number) => boolean

    Liquid predicate (e.g. t => waterTerrainSet.has(t)). When provided, overlays on liquid cells sit on the computed water surface instead of the seabed floor, matching what the user sees.

    elevationScale?: number

    Must match the terrain geometry's elevationScale. Default ELEVATION_SCALE.