IEventEmitter

Provides an interface for emitting and listening to events.

Type	Name	Interface Description
Functions	emit(event: IEvent): void	• Function: Emits a specified event. Parameters • event: - The event object to be emitted.
Functions	off(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void	• Function: Unregisters an event listener for a specified event type. Parameters • eventType: - The type of event to unregister. • callback: - The callback function that was previously registered. • context: - The execution context that was used when registering the callback.
Functions	on(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void	• Function: Registers an event listener for a specified event type. Parameters • eventType: - The type of event to listen for. • callback: - The callback function to be invoked when the event is triggered. • context: - The execution context for the callback function.
Functions	once(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void	• Function: Registers a one-time event listener for a specified event type. Parameters • eventType: - The type of event to listen for. • callback: - The callback function to be invoked when the event is triggered. • context: - The execution context for the callback function.

Examples

emit(event: IEvent): void

emitter.emit(APJS.EventManager.createEvent(MY_EVENT_TYPE));

off(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void

emitter.off(myEventType, this.onMyEventType, this);

on(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void

emitter.on(myEventType, this.onMyEventType, this);

once(eventType: number | UserEventType, callback: (event: IEvent) => void, context?: object): void

emitter.once(myEventType, this.onMyEventType, this);

Use Case

@component()
export class NewBehaviourScript extends APJS.BasicScriptComponent {
  onStart() {
    // TODO: instantiate / use IEventEmitter here
  }
  onUpdate(deltaTime: number) {
  }
}