threejs-worldgen
    Preparing search index...

    Interface FishSchoolsOptions

    Options for FishSchools.create.

    interface FishSchoolsOptions {
        boids?: DeepPartial<BoidWeights>;
        buildBudget?: number;
        camera: Camera;
        castShadow?: boolean;
        density?: number;
        detail?: DeepPartial<FishDetail>;
        gridResolution?: number;
        margin?: number;
        maxDistance?: number;
        minWavelength?: number;
        origin?: [number, number, number];
        predators?: Predator[];
        receiveShadow?: boolean;
        reframeDistance?: number;
        renderer?: FaunaRenderer;
        scene?: Object3D<Object3DEventMap>;
        seed?: string | number;
        simDistance?: number;
        species?: DeepPartial<Record<string, FishSpecies>>;
        states?: DeepPartial<MaterialStates>;
        stepRate?: number;
        tileSize?: number;
        water?: DeepPartial<WaterRules>;
        world: World;
    }

    Hierarchy (View Summary)

    Index
    boids? buildBudget? camera castShadow? density? detail? gridResolution? margin? maxDistance? minWavelength? origin? predators? receiveShadow? reframeDistance? renderer? scene? seed? simDistance? species? states? stepRate? tileSize? water? world
    boids?: DeepPartial<BoidWeights>

    Boid weights.

    buildBudget?: number

    Milliseconds per frame spent spawning groups, nearest first.

    camera: Camera

    Camera groups stream around.

    castShadow?: boolean

    Whether animals cast shadows.

    density?: number

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

    detail?: DeepPartial<FishDetail>

    Mesh resolution.

    gridResolution?: number

    Samples per side of each group's environment grid.

    margin?: number

    Extra clearance (metres) from the bed and the surface, on top of each fish's own size.

    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?: [number, number, number]

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

    predators?: Predator[]

    Objects fish flee from (e.g. the camera, a diver, a shark).

    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.

    renderer?: FaunaRenderer

    A WebGPURenderer; initialised if needed.

    scene?: Object3D<Object3DEventMap>

    If given, the layer is added to it and updates whenever it renders.

    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?: DeepPartial<Record<string, FishSpecies>>

    Species that can spawn, by id (defaults to FISH_SPECIES). Set a species' habitat.weight to 0 to turn it off.

    states?: DeepPartial<MaterialStates>

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

    stepRate?: number

    Fixed simulation steps per second.

    tileSize?: number

    Edge length of a streaming tile, metres.

    water?: DeepPartial<WaterRules>

    How river water is told from sea water.

    world: World

    World that decides where animals live. Groups respawn when it changes.

    Settings
    Member Visibility

    On This Page
    Properties