Phaser Class: SignalBinding

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

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	Default	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>	null	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).
`args`	any	<optional> <repeatable>	(none)	Additional arguments to pass to the callback (listener) function. They will be appended after any arguments usually dispatched.

Source - core/SignalBinding.js, line 22

Members

active :boolean

If binding is active and should be executed.

Default Value:

true

Source - core/SignalBinding.js, line 93

callCount :number

The number of times the handler function has been called.

Source - core/SignalBinding.js, line 86

context :object

Context on which listener will be executed (object that should represent the this variable inside listener function).

Source - core/SignalBinding.js, line 63

params :array|null

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

Type:

array | null

Default Value:

null

Source - core/SignalBinding.js, line 100

Methods

detach() → {function|null}

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

Returns:

function | null -

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

Source - core/SignalBinding.js, line 136

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.