Class EventDispatcher<E>

JavaScript events for custom objects

Source

src/core/EventDispatcher.js

Type Parameters

E extends BaseEvent = Event

Hierarchy

EventDispatcher

Index

Constructors

Methods

addEventListener dispatchEvent hasEventListener removeEventListener

Constructors

constructor

new EventDispatcher<E>(): EventDispatcher<E>
Creates eventDispatcher object. It needs to be call with '.call' to add the functionality to an object.
Type Parameters
- E extends BaseEvent = Event
Returns EventDispatcher<E>
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:23

Methods

addEventListener

addEventListener<T>(type: T, listener: EventListener<E, T, EventDispatcher<E>>): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<E, T, EventDispatcher<E>>
  
  The function that gets called when the event is fired.
Returns void
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:30

dispatchEvent

dispatchEvent(event: E): void
Fire an event type.
Parameters
- event: E
Returns void
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<E, T, EventDispatcher<E>>): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<E, T, EventDispatcher<E>>
  
  The function that gets called when the event is fired.
Returns boolean
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:37

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<E, T, EventDispatcher<E>>): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<E, T, EventDispatcher<E>>
  
  The listener function that gets removed.
Returns void
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:44

Generated using TypeDoc