Interface Habitat<S>

What a kind of animal (fish, birds, …) tells placement about its species.

interface Habitat<S> {
    band(species: S, sample: WorldSample, out: Band): boolean;
    groupSize(species: S): [number, number];
    minThickness(species: S): number;
    roam(species: S): number;
    suitability(species: S, sample: WorldSample): number;
}

Type Parameters

S

Index

Methods

band groupSize minThickness roam suitability

Methods

band

band(species: S, sample: WorldSample, out: Band): boolean
The raw usable band for a species at a sample (e.g. riverbed … water surface); false = unusable.
Parameters
- species: S
- sample: WorldSample
- out: Band
Returns boolean
- Defined in fauna/src/placement.ts:21

groupSize

groupSize(species: S): [number, number]
Group size range [min, max].
Parameters
- species: S
Returns [number, number]
- Defined in fauna/src/placement.ts:25

minThickness

minThickness(species: S): number
The thinnest band a species can use (its margins plus its body).
Parameters
- species: S
Returns number
- Defined in fauna/src/placement.ts:23

roam

roam(species: S): number
How far (metres) a group roams from home; also the half-size of its environment grid.
Parameters
- species: S
Returns number
- Defined in fauna/src/placement.ts:27

suitability

suitability(species: S, sample: WorldSample): number
Weighted suitability (0 = never here) of a species at a world sample.
Parameters
- species: S
- sample: WorldSample
Returns number
- Defined in fauna/src/placement.ts:19