1681-engine / index / DayClock

Class: DayClock<P>

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

Type Parameters

Type Parameter	Default type
P extends string	string

Constructors

Constructor

new DayClock<P>(options): DayClock<P>;

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

Parameters

Parameter	Type
options	DayClockOptions<P>

Returns

DayClock<P>

Methods

at()

at(ms): DayState<P>;

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

Parameters

Parameter	Type
ms	number

Returns

DayState<P>

---

hold()

hold(phase): void;

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

Holds the day at phase (0..1), or lets it run again with null.

Parameters

Parameter	Type
phase	number | null

Returns

void

---

phaseAt()

phaseAt(ms): number;

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

Where the day stands at wall time ms (0..1).

Parameters

Parameter	Type
ms	number

Returns

number