threejs-worldgen
    Preparing search index...

    Interface BirdFlocksSettings

    Every setting of BirdFlocks.

    interface BirdFlocksSettings {
        boids: BoidWeights;
        buildBudget: number;
        castShadow: boolean;
        density: number;
        gridResolution: number;
        maxDistance: number;
        minWavelength: number;
        origin: [x: number, y: number, z: number];
        predators: Predator[];
        receiveShadow: boolean;
        reframeDistance: number;
        seed: string | number;
        simDistance: number;
        species: Record<string, BirdSpecies>;
        states: MaterialStates;
        stepRate: number;
        tileSize: number;
    }

    Hierarchy (View Summary)

    Index

    Boid weights.

    buildBudget: number

    Milliseconds per frame spent spawning groups, nearest first.

    castShadow: boolean

    Whether animals cast shadows.

    density: number

    Group candidates per km²; candidates in unsuitable places are dropped.

    gridResolution: number

    Samples per side of each group's environment grid.

    maxDistance: number

    Groups farther than this from the camera are dropped (and nothing spawns while the camera is higher than this).

    minWavelength: number

    Skip world detail smaller than this (metres) when sampling.

    origin: [x: number, y: number, z: number]

    World position that is (0, 0, 0) in render space (floating origin).

    predators: Predator[]

    Objects animals flee from (not JSON: objects or React refs).

    receiveShadow: boolean

    Whether animals receive shadows.

    reframeDistance: number

    Planets: distance (metres) from the frame's centre at which a new frame is centred on the camera.

    seed: string | number

    Seed: the same seed, world and settings always spawn the same groups.

    simDistance: number

    Groups farther than this are drawn but not simulated.

    species: Record<string, BirdSpecies>

    Species that can spawn, by id (defaults to BIRD_SPECIES).

    Material states (wetness, snow, burn, damage).

    stepRate: number

    Fixed simulation steps per second.

    tileSize: number

    Edge length of a streaming tile, metres.