1681-engine / index / FirefliesOptions

Interface: FirefliesOptions

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

Properties

count

count: number;

Defined in: src/ambient/life/Fireflies.ts:7

---

depth?

optional depth?: number;

Defined in: src/ambient/life/Fireflies.ts:19

World-layer depth when layer is 'world' (default 900_000).

---

frames

frames: readonly [string, string];

Defined in: src/ambient/life/Fireflies.ts:9

The two frames: a dim pixel, and the glow.

---

home

home: LifeSource;

Defined in: src/ambient/life/Fireflies.ts:11

Somewhere in view to hover round (the water's edge, the feet of trees), or null when none is on screen.

---

layer?

optional layer?: "screen" | "world";

Defined in: src/ambient/life/Fireflies.ts:17

Where the layer goes. Default 'screen': on the screen layer, following the camera, so it can be laid over a darkness drawn there (NightShade, Darkness) instead of being darkened with the world under it — add it after the darkness. 'world': in the world layer at depth, for a game with no darkness over its world.

---

random?

optional random?: () => number;

Defined in: src/ambient/life/Fireflies.ts:21

Returns

number

---

snap?

optional snap?: boolean;

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