threejs-worldgen
    Preparing search index...

    Interface FaunaOptions

    Options for Fauna.create.

    interface FaunaOptions {
        birds?: false | BirdFlocksInput;
        camera: Camera;
        fish?: false | FishSchoolsInput;
        origin?: [number, number, number];
        predators?: Predator[];
        renderer?: FaunaRenderer;
        scene?: Object3D<Object3DEventMap>;
        seed?: string | number;
        states?: Partial<MaterialStates>;
        world: World;
        [kind: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [kind: string]: unknown

      Settings of kinds added to FAUNA_KINDS.

    Index
    birds? camera fish? origin? predators? renderer? scene? seed? states? world
    birds?: false | BirdFlocksInput

    Bird flocks, or false for none.

    camera: Camera

    Camera everything streams around.

    fish?: false | FishSchoolsInput

    Fish schools, or false for none.

    origin?: [number, number, number]

    Floating origin for every kind.

    predators?: Predator[]

    Objects every kind flees from (not JSON).

    renderer?: FaunaRenderer

    A WebGPURenderer; initialised if needed.

    scene?: Object3D<Object3DEventMap>

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

    seed?: string | number

    Seed for every kind.

    states?: Partial<MaterialStates>

    Material states for every kind.

    world: World

    The world that decides where animals live.

    Settings
    Member Visibility

    On This Page
    Properties