threejs-worldgen
    Preparing search index...

    Interface FaunaProps

    Props of <Fauna>: every FaunaInput setting plus the ones below.

    interface FaunaProps {
        birds?: false | BirdFlocksInput;
        camera?: Camera;
        fish?: false | FishSchoolsInput;
        origin?: [number, number, number];
        predators?: Predator[];
        ref?: Ref<Fauna | null>;
        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? ref? seed? states? world
    birds?: false | BirdFlocksInput

    Bird flocks, or false for none.

    camera?: Camera

    Camera everything streams around. Defaults to the R3F default camera.

    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).

    ref?: Ref<Fauna | null>

    Receives the underlying Fauna (for layers, …).

    seed?: string | number

    Seed for every kind.

    states?: Partial<MaterialStates>

    Material states for every kind.

    world: World

    The world animals live in.

    Settings
    Member Visibility

    On This Page
    Properties