Class: EventEmitter

Methods

---

addListener(event, fn [, context])

Add a listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
event	string | symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 111)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

destroy()

Removes all listeners.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 42)

---

emit(event [, args])

Calls each of the listeners registered for a given event.

Parameters:

Name	Type	Argument	Description
event	string | symbol		The event name.
args	*	<optional> <repeatable>	Additional arguments that will be passed to the event handler.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 86)

Returns:

true if the event had listeners, else false.

Type

boolean

---

eventNames()

Return an array listing the events for which the emitter has registered listeners.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 55)

Returns:

Type

Array.<(string|symbol)>

---

listenerCount(event)

Return the number of listeners listening to a given event.

Parameters:

Name	Type	Description
event	string | symbol	The event name.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 75)

Returns:

The number of listeners.

Type

number

---

listeners(event)

Return the listeners registered for a given event.

Parameters:

Name	Type	Description
event	string | symbol	The event name.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 64)

Returns:

The registered listeners.

Type

Array.<function()>

---

off(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:

Name	Type	Argument	Description
event	string | symbol		The event name.
fn	function	<optional>	Only remove the listeners that match this function.
context	*	<optional>	Only remove the listeners that have this context.
once	boolean	<optional>	Only remove one-time listeners.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 151)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

on(event, fn [, context])

Add a listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
event	string | symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 98)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

once(event, fn [, context])

Add a one-time listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
event	string | symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 124)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

removeAllListeners( [event])

Remove all listeners, or those of the specified event.

Parameters:

Name	Type	Argument	Description
event	string | symbol	<optional>	The event name.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 165)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

removeListener(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:

Name	Type	Argument	Description
event	string | symbol		The event name.
fn	function	<optional>	Only remove the listeners that match this function.
context	*	<optional>	Only remove the listeners that have this context.
once	boolean	<optional>	Only remove one-time listeners.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 137)

Returns:

this.

Type

Phaser.Events.EventEmitter

---

shutdown()

Removes all listeners.

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 31)