EventDispatcher

Type class

Universal Event Dispatcher.

Click here for more info

Sources

This information about EventDispatcher is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

EventDispatcher does not extend any other symbol.

EventDispatcher is extended by SpriteEventDispatcher.

Settings

EventDispatcher does not have any settings.

Private settings

EventDispatcher does not have any private settings.

Properties

EventDispatcher does not have any properties.

Methods

constructor()

#

Returns EventDispatcher

Constructor

disable()

#

Returns void

Disable dispatching of events until re-enabled by enable().

disableType(

type: Key,
amount: number

)

#

Returns void

Disable dispatching of events for a certain event type.

Optionally, can set how many dispatches to skip before automatically re-enabling the dispatching.

dispatch(

type: Key,
event: T[""]

)

#

Returns void

Dispatches an event immediately without waiting for next cycle.

@todo automatically add in type and target properties if they are missing

dispose()

#

Returns void

Dispose (destroy) this object.

enable()

#

Returns void

Enable dispatching of events if they were previously disabled by disable().

enableType(

type: Key

)

#

Returns void

Enable dispatching particular event, if it was disabled before by disableType().

has(

type: Key,
callback?: undefined | ( this: C, event: T[""]) => void,
context?: C

)

#

Returns boolean

Checks if there's already a listener with specific parameters.

hasListeners()

#

Returns boolean

Checks if this particular event dispatcher has any listeners set.

hasListenersByType(

type: Key

)

#

Returns boolean

Checks if this particular event dispatcher has any particular listeners set.

isDisposed()

#

Returns boolean

Returns if this object has been already disposed.

isEnabled(

type: Key

)

#

Returns boolean

Checks if dispatching for particular event type is enabled.

off(

type: Key,
callback?: undefined | ( this: C, event: T[""]) => void,
context?: C

)

#

Returns void

Removes the event listener with specific parameters.

on(

type: Key,
callback: ( this: C | undefined, event: T[""]) => void,
context?: C,
shouldClone: boolean

)

#

Returns IDisposer

Creates an event listener to be invoked on a specific event type.

button.events.once("click", (ev) => {
  console.log("Button clicked");
}, this);
button.events.once("click", (ev) => {
  console.log("Button clicked");
}, this);

The above will invoke our custom event handler whenever series we put event on is hidden.

onAll(

callback: ( this: C, event: T[""]) => void,
context?: C,
shouldClone: boolean

)

#

Returns IDisposer

Creates an event listener to be invoked on any event.

once(

type: Key,
callback: ( this: C | undefined, event: T[""]) => void,
context?: C,
shouldClone: boolean

)

#

Returns IDisposer

Creates an event listener to be invoked on a specific event type once.

Once the event listener is invoked, it is automatically disposed.

button.events.once("click", (ev) => {
  console.log("Button clicked");
}, this);
button.events.once("click", (ev) => {
  console.log("Button clicked");
}, this);

The above will invoke our custom event handler the first time series we put event on is hidden.

removeType(

type: Key

)

#

Returns void

Removes all listeners of a particular event type

Events

EventDispatcher does not have any events.