Phaser Class: SignalBinding

new SignalBinding(signal, listener, isOnce, listenerContext, priority)

Object that represents a binding between a Signal and a listener function. This is an internal constructor and shouldn't be created directly. Inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.

Parameters:

Name	Type	Argument	Description
`signal`	Phaser.Signal		Reference to Signal object that listener is currently bound to.
`listener`	function		Handler function bound to the signal.
`isOnce`	boolean		If binding should be executed just once.
`listenerContext`	object	<optional>	Context on which listener will be executed (object that should represent the `this` variable inside listener function).
`priority`	number	<optional>	The priority level of the event listener. (default = 0).

Source:

core/SignalBinding.js, line 21

Members

active

If binding is active and should be executed.

Properties:

Name	Type	Description
`active`	boolean

Default Value:

true

Source:

core/SignalBinding.js, line 61

context

Properties:

Name	Type	Description
`context`	object \| undefined \| null	Context on which listener will be executed (object that should represent the `this` variable inside listener function).

Source:

core/SignalBinding.js, line 38

params

Default parameters passed to listener during Signal.dispatch and SignalBinding.execute (curried parameters).

Properties:

Name	Type	Description
`params`	array \| null

Default Value:

null

Source:

core/SignalBinding.js, line 68

Methods

detach() → {function|null}

Detach binding from signal. alias to: @see mySignal.remove(myBinding.getListener());

Source:

core/SignalBinding.js, line 96

Returns:

Handler function bound to the signal or null if binding was previously detached.

Type: function | null

execute(paramsArr) → {any}

Call listener passing arbitrary parameters. If binding was added using Signal.addOnce() it will be automatically removed from signal dispatch queue, this method is used internally for the signal dispatch.