1681-engine / index / BirdsOptions

Interface: BirdsOptions

Defined in: src/ambient/life/Birds.ts:6

Properties

depth?

optional depth?: number;

Defined in: src/ambient/life/Birds.ts:18

Depth of the birds (default 950_000: over every prop and body, under the names).

---

everyS

everyS: readonly [number, number];

Defined in: src/ambient/life/Birds.ts:10

Seconds between flocks, [least, most].

---

firstMs?

optional firstMs?: readonly [number, number];

Defined in: src/ambient/life/Birds.ts:24

The first flock comes this many ms after the first update, [least, most] (default [3000, 9000]).

---

flock

flock: readonly [number, number];

Defined in: src/ambient/life/Birds.ts:8

Birds in a flock, [least, most]; never more than maxFlock.

---

frames

frames: readonly [string, string];

Defined in: src/ambient/life/Birds.ts:12

The two frames, seen from above: wings raised (a V), then the downstroke.

---

maxFlock?

optional maxFlock?: number;

Defined in: src/ambient/life/Birds.ts:16

The pool's size (default 6).

---

maxNight?

optional maxNight?: number;

Defined in: src/ambient/life/Birds.ts:22

Past this night no flock sets off (default 0.5).

---

random?

optional random?: () => number;

Defined in: src/ambient/life/Birds.ts:26

Returns

number

---

shadow?

optional shadow?: string;

Defined in: src/ambient/life/Birds.ts:14

A small shadow on the ground far below each bird: it is what tells the eye how high they are.

---

shadowDepth?

optional shadowDepth?: number;

Defined in: src/ambient/life/Birds.ts:20

Depth of their shadows (default -999_980: on the ground, under the bodies).

---

snap?

optional snap?: boolean;

Defined in: src/ambient/life/Birds.ts:25