Skip to content

1681-engine / index / Birds

Class: Birds ​

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

A flock crossing the sky now and then: a few painted birds in a loose V flying straight across the camera's view, wings beating on their own clocks, each with its shadow on the ground below. Not at night.

Constructors ​

Constructor ​

ts
new Birds(stage, options): Birds;

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

Parameters ​

ParameterType
stageStage
optionsBirdsOptions

Returns ​

Birds

Accessors ​

flying ​

Get Signature ​

ts
get flying(): boolean;

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

Whether a flock is crossing now.

Returns ​

boolean

Methods ​

destroy() ​

ts
destroy(): void;

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

Returns ​

void


update() ​

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

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

Parameters ​

ParameterTypeDefault value
nownumberundefined
dtnumberundefined
viewViewRectundefined
airLifeAirundefined
enabledbooleantrue

Returns ​

void

Released under the MIT License.