threejs-worldgen
    Preparing search index...

    Interface FishOptions

    Options for Fish.create.

    interface FishOptions {
        castShadow?: boolean;
        detail?: DeepPartial<FishDetail>;
        preset?: string;
        receiveShadow?: boolean;
        renderer?: FaunaRenderer;
        scene?: Object3D<Object3DEventMap>;
        seed?: string | number;
        species?: DeepPartial<FishSpecies>;
        speed?: number;
        states?: DeepPartial<MaterialStates>;
        turn?: number;
    }

    Hierarchy (View Summary)

    Index
    castShadow? detail? preset? receiveShadow? renderer? scene? seed? species? speed? states? turn?
    castShadow?: boolean

    Whether it casts shadows.

    detail?: DeepPartial<FishDetail>

    Mesh resolution.

    preset?: string

    Starting species id.

    receiveShadow?: boolean

    Whether it receives shadows.

    renderer?: FaunaRenderer

    A WebGPURenderer; initialised if needed.

    scene?: Object3D<Object3DEventMap>

    If given, the fish is added to it and animates whenever it renders.

    seed?: string | number

    Seed for this fish's size and colour variation.

    species?: DeepPartial<FishSpecies>

    The species, resolved from preset plus your overrides.

    speed?: number

    Swimming speed in body lengths per second (drives the tail beat).

    states?: DeepPartial<MaterialStates>

    Material states.

    turn?: number

    −1 … 1: how hard it is turning (bends the body).

    Settings
    Member Visibility

    On This Page
    Properties