Class EventBus

Extension of Phaser.Events.EventEmitter with custom event names

Hierarchy (View Summary)

EventEmitter
- EventBus

Index

Constructors

constructor

Methods

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

Constructors

constructor

new EventBus(): EventBus

Returns EventBus

Inherited from EventEmitter.constructor

Methods

addListener

addListener<D = any, C = any>(
    event: AnyEvent,
    fn: EventCallbackFn<D>,
    context?: C,
): this
Add a listener for a given event.
Type Parameters
- D = any
- C = any
Parameters
- event: AnyEvent
  The event name.
- fn: EventCallbackFn<D>
  The listener function.
- Optionalcontext: C
  The context to invoke the listener with. Default this.
Returns this
this.
Overrides EventEmitter.addListener
- Defined in src/event-bus.ts:28

destroy

destroy(): void
Removes all listeners from this EventEmitter and prepares it for garbage collection. This method is called automatically when the parent object is destroyed and should not be called directly unless you are tearing down the emitter manually.

Returns void
Inherited from EventEmitter.destroy
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10961

emit

emit(event: AnyEvent, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: AnyEvent
  The event name.
- ...args: any[]
  Additional arguments that will be passed to the event handler.
Returns boolean
true if the event had listeners, else false.
Overrides EventEmitter.emit
- Defined in src/event-bus.ts:20

eventNames

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

Returns (string | symbol)[]
undefined
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10967

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
The number of listeners.
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10981

listeners

listeners(event: string | symbol): Function[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
Returns Function[]
The registered listeners.
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10974

off

off<D = any, C = any>(
    event: AnyEvent,
    fn?: EventCallbackFn<D>,
    context?: C,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- D = any
- C = any
Parameters
- event: AnyEvent
  The event name.
- Optionalfn: EventCallbackFn<D>
  Only remove the listeners that match this function.
- Optionalcontext: C
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
this.
Overrides EventEmitter.off
- Defined in src/event-bus.ts:16

on

on<D = any, C = any>(event: AnyEvent, fn: EventCallbackFn<D>, context?: C): this
Add a listener for a given event.
Type Parameters
- D = any
- C = any
Parameters
- event: AnyEvent
  The event name.
- fn: EventCallbackFn<D>
  The listener function.
- Optionalcontext: C
  The context to invoke the listener with. Default this.
Returns this
this.
Overrides EventEmitter.on
- Defined in src/event-bus.ts:8

once

once<D = any, C = any>(
    event: AnyEvent,
    fn: EventCallbackFn<D>,
    context?: C,
): this
Add a one-time listener for a given event. The listener is automatically removed the first time the event is emitted, so it will never be called more than once.
Type Parameters
- D = any
- C = any
Parameters
- event: AnyEvent
  The event name.
- fn: EventCallbackFn<D>
  The listener function.
- Optionalcontext: C
  The context to invoke the listener with. Default this.
Returns this
this.
Overrides EventEmitter.once
- Defined in src/event-bus.ts:12

removeAllListeners

removeAllListeners(event?: AnyEvent): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: AnyEvent
  The event name.
Returns this
this.
Overrides EventEmitter.removeAllListeners
- Defined in src/event-bus.ts:24

removeListener

removeListener<D = any, C = any>(
    event: AnyEvent,
    fn?: EventCallbackFn<D>,
    context?: C,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- D = any
- C = any
Parameters
- event: AnyEvent
  The event name.
- Optionalfn: EventCallbackFn<D>
  Only remove the listeners that match this function.
- Optionalcontext: C
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
this.
Overrides EventEmitter.removeListener
- Defined in src/event-bus.ts:32

shutdown

shutdown(): void
Removes all listeners from this EventEmitter. This method is called automatically by the Scene Systems when the parent Scene shuts down, ensuring that all event bindings are cleared and no stale references remain.

Returns void
Inherited from EventEmitter.shutdown
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:10954

Class EventBus

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns EventBus

Methods

addListener

Type Parameters

Parameters

Returns this

destroy

Returns void

emit

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Parameters

Returns Function[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

shutdown

Returns void

Settings

On This Page