Interface IEngineEventListenerTarget

Base interface for all reading system classes that can dispatch EngineEvents, such as ReadingSystemEngine, ReaderView, etc.

Hierarchy

IEngineEventListenerTarget

Index

Methods

Methods

addEngineEventListener

addEngineEventListener<T>(type: T, listener: IEngineEventListener<IEngineEventTypeMap[T]>): void

Adds an EngineEvent listener to this instance.

Type parameters
- T: keyof IEngineEventTypeMap
Parameters
- type: T
  
  The EngineEvent type to listen to.
- listener: IEngineEventListener<IEngineEventTypeMap[T]>
  
  The object or callback function that should receive events.
Returns void

getEngineEventListeners

getEngineEventListeners<T>(type: T): IEngineEventListener<IEngineEventTypeMap[T]>[]

Get all EngineEvent listeners for the specified type that has been added to this instance.

Type parameters
- T: keyof IEngineEventTypeMap
Parameters
- type: T
Returns IEngineEventListener<IEngineEventTypeMap[T]>[]

removeEngineEventListener

removeEngineEventListener<T>(type: T, listener: IEngineEventListener<IEngineEventTypeMap[T]>): void

Removes an EngineEvent listener that was previously added to this instance.

Type parameters
- T: keyof IEngineEventTypeMap
Parameters
- type: T
  
  The EngineEvent type to remove.
- listener: IEngineEventListener<IEngineEventTypeMap[T]>
  
  The object or callback function to remove.
Returns void

Generated using TypeDoc