Class EventEmitter

EventEmitter is a Scene Systems plugin compatible version of eventemitter3.

Index

Constructors

constructor

Methods

addListener destroy emit eventNames listenerCount listeners off on once removeAllListeners removeListener shutdown

Constructors

constructor

new EventEmitter(): EventEmitter
Returns EventEmitter

Methods

addListener

addListener(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
- Defined in types/phaser.d.ts:9645

destroy

destroy(): void
Removes all listeners.

Returns void
- Defined in types/phaser.d.ts:9605

emit

emit(event: string | symbol, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
- ...args: any[]
  Additional arguments that will be passed to the event handler.
Returns boolean
- Defined in types/phaser.d.ts:9629

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
- Defined in types/phaser.d.ts:9610

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
  The event name.
Returns number
- Defined in types/phaser.d.ts:9622

listeners

listeners(event: string | symbol): Function[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
Returns Function[]
- Defined in types/phaser.d.ts:9616

off

off(event: string | symbol, fn?: Function, context?: any, once?: boolean): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
- Defined in types/phaser.d.ts:9671

on

on(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
- Defined in types/phaser.d.ts:9637

once

once(event: string | symbol, fn: Function, context?: any): this
Add a one-time listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
- Defined in types/phaser.d.ts:9653

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
  The event name.
Returns this
- Defined in types/phaser.d.ts:9677

removeListener

removeListener(
    event: string | symbol,
    fn?: Function,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
- Defined in types/phaser.d.ts:9662

shutdown

shutdown(): void
Removes all listeners.

Returns void
- Defined in types/phaser.d.ts:9600

Class EventEmitter

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns EventEmitter

Methods

addListener

Parameters

Returns this

destroy

Returns void

emit

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Parameters

Returns Function[]

off

Parameters

Returns this

on

Parameters

Returns this

once

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Parameters

Returns this

shutdown

Returns void

Settings

On This Page