Skip to content

1681-engine / index / Fireflies

Class: Fireflies ​

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

Fireflies at night: single pixels drifting slowly round homes on screen, each lighting up and going out on its own clock. How many are out grows with the dark (none before night 0.5, all by 0.85). They are a light, so by default their layer sits on the screen and follows the camera (Camera.follow copies the world layer's transform, shake included, once the frame's camera is known).

Constructors ​

Constructor ​

ts
new Fireflies(stage, options): Fireflies;

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

Parameters ​

ParameterType
stageStage
optionsFirefliesOptions

Returns ​

Fireflies

Properties ​

layer ​

ts
readonly layer: Container<ContainerChild>;

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

Methods ​

destroy() ​

ts
destroy(): void;

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

Returns ​

void


update() ​

ts
update(
   now, 
   view, 
   air, 
   enabled?
): void;

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

Parameters ​

ParameterTypeDefault value
nownumberundefined
viewViewRectundefined
airLifeAirundefined
enabledbooleantrue

Returns ​

void

Released under the MIT License.