Class: EntityEvents

Per-entity emitter, lazily created on first listener attach so listener-free entities cost nothing. context is the listener's this and part of its off() identity. Synchronous, in registration order; throwing listeners are logged and don't take down siblings.

Constructors

Constructor

new EntityEvents(): EntityEvents;

Returns

EntityEvents

Methods

Clear()

Clear(): void;

Returns

void

---

emit()

emit<T>(name, payload?): void;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
payload?	T

Returns

void

---

HasListeners()

HasListeners(name): boolean;

Parameters

Parameter	Type
name	string

Returns

boolean

---

ListenerCount()

ListenerCount(name?): number;

Parameters

Parameter	Type
name?	string

Returns

number

---

off()

off<T>(
   name, 
   cb?, 
   context?
): void;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
cb?	EntityEventHandler<T>
context?	object

Returns

void

---

on()

on<T>(
   name, 
   cb, 
   context?
): EntityEventUnsubscribe;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
cb	EntityEventHandler<T>
context?	object

Returns

EntityEventUnsubscribe

---

once()

once<T>(
   name, 
   cb, 
   context?
): EntityEventUnsubscribe;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
cb	EntityEventHandler<T>
context?	object

Returns

EntityEventUnsubscribe