hex-world
    Preparing search index...

    Interface ScatterDescriptor

    Fully serializable description of a scatter layer. Embeds in a map save file. Does not hold Three.js objects — assets are referenced by stable string ID and resolved at load time via a registry.

    interface ScatterDescriptor {
        id: string;
        name: string;
        layerIndex: number;
        tiers: ScatterVariantDescriptor[][];
        allowedTerrains?: number[];
        tiltStrength?: number;
        placement?: ScatterPlacementRules;
        thresholds?: ScatterThresholds;
    }
    Index

    Properties

    id name layerIndex tiers allowedTerrains? tiltStrength? placement? thresholds?

    Properties

    id: string
    name: string
    layerIndex: number

    Feature layer slot index in HexMap.featureData. Must be unique per map.

    tiers: ScatterVariantDescriptor[][]

    [tier 0=dense → tier 2=sparse][variant within tier]

    allowedTerrains?: number[]

    If set, only cells whose terrain type index is in this list can host this scatter.

    tiltStrength?: number

    Random X/Z tilt applied to each instance matrix (radians). 0 = upright only.

    placement?: ScatterPlacementRules

    Elevation band, shore, and river rules — see ScatterPlacementRules.

    thresholds?: ScatterThresholds

    Own density curve; omit for the shared default. See ScatterThresholds.

    Settings

    Member Visibility

    On This Page

    Properties