Interface ScatterSettings

Every setting of a Scatter.

interface ScatterSettings {
    buildBudget: number;
    layers: ScatterLayer[];
    lodHysteresis: number;
    maxDistance: number;
    refreshDistance: number;
    seed: number;
    tileSize: number;
}

Properties

buildBudget: number

Milliseconds per frame spent generating tiles, nearest first.

The kinds of objects to scatter.

lodHysteresis: number

Fractional band around LOD distances that an instance must cross before switching level (stops flicker).

maxDistance: number

Nothing is generated beyond this distance from the camera (each layer also stops at its last LOD distance).

refreshDistance: number

How far (metres) the camera moves before instances are re-sorted into levels of detail.

seed: number

World seed. Same seed + same layers = same placement.

tileSize: number

Edge length of a streaming tile, in metres.