Interface FishSettings

Every setting of a hero Fish.

interface FishSettings {
    castShadow: boolean;
    detail: FishDetail;
    preset: string;
    receiveShadow: boolean;
    seed: string | number;
    species: FishSpecies;
    speed: number;
    states: MaterialStates;
    turn: number;
}

Properties

castShadow: boolean

Whether it casts shadows.

Mesh resolution.

preset: string

Starting species (an id in FISH_SPECIES).

receiveShadow: boolean

Whether it receives shadows.

seed: string | number

Seed for this fish's size and colour variation.

The species, resolved from preset plus your overrides.

speed: number

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

Material states.

turn: number

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