Skip to content

1681-engine / index / DayClockOptions

Interface: DayClockOptions<P> ​

Defined in: src/ambient/DayClock.ts:37

Type Parameters ​

Type ParameterDefault type
P extends stringstring

Properties ​

keys ​

ts
keys: readonly DayKey[];

Defined in: src/ambient/DayClock.ts:43

At least one key.


offsetMs? ​

ts
optional offsetMs?: number;

Defined in: src/ambient/DayClock.ts:41

Shifts the day against the wall clock (the same offset on every client keeps them together).


periodMs ​

ts
periodMs: number;

Defined in: src/ambient/DayClock.ts:39

Real milliseconds a whole game day lasts.


phases? ​

ts
optional phases?: readonly DayPhase<P>[];

Defined in: src/ambient/DayClock.ts:45

Optional names for parts of the day; without them id is ''.

Released under the MIT License.