Kiln API / kiln / DelayedEvents

Class: DelayedEvents

Events sent later: res.mut(Delayed).emit(3, RoundStart, { round: 2 }) emits RoundStart 3 seconds (of fixed steps) from now, in Fixed. cancel(E) drops pending ones. Survives snapshots when the event is a named export.

Constructors

Constructor

new DelayedEvents(app): DelayedEvents;

Parameters

Parameter	Type
app	App

Returns

DelayedEvents

Properties

pending

pending: Pending[] = [];

Methods

emit()

emit<T>(
   seconds, 
   e, 
   ...payload
): void;

Emits e with payload after seconds of simulated time (at least one fixed step).

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
seconds	number
e	EventType<T>
...payload	T extends void ? [] : [T]

Returns

void

---

cancel()

cancel(e?): number;

Drops pending emits of e (or all of them). Returns how many were dropped.

Parameters

Parameter	Type
e?	EventType<any>

Returns

number

---

timeLeft()

timeLeft(e): number | null;

Seconds until the next pending e, or null.

Parameters

Parameter	Type
e	EventType<any>

Returns

number | null

---

toJSON()

toJSON(): object;

Returns

object

pending

pending: object[];

---

restore()

restore(json): void;

Parameters

Parameter	Type
json	{ pending: object[]; }
json.pending	object[]

Returns

void