threejs-worldgen
    Preparing search index...

    Interface ScatterOptions

    Options for Scatter.create.

    interface ScatterOptions {
        buildBudget?: number;
        camera: Camera;
        layers?: ScatterLayerInput[];
        lodHysteresis?: number;
        maxDistance?: number;
        refreshDistance?: number;
        scene?: Object3D<Object3DEventMap>;
        seed?: number;
        terrain?: Terrain;
        tileSize?: number;
    }

    Hierarchy (View Summary)

    Index
    buildBudget? camera layers? lodHysteresis? maxDistance? refreshDistance? scene? seed? terrain? tileSize?
    buildBudget?: number

    Milliseconds per frame spent generating tiles, nearest first.

    camera: Camera

    The camera tiles stream around and whose distance picks levels of detail.

    layers?: ScatterLayerInput[]

    Layers to scatter; replaces the previous list. Missing layer fields take their defaults.

    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.

    scene?: Object3D<Object3DEventMap>

    If given, the scatter is added to it and updates itself whenever it renders (scene.onBeforeRender).

    seed?: number

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

    terrain?: Terrain

    Mesh/group to scatter on (baked into a heightfield once), a (x, z) => y function, or omit for flat ground.

    tileSize?: number

    Edge length of a streaming tile, in metres.

    Settings
    Member Visibility

    On This Page
    Properties