These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser. 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 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).

Source code: core/SignalBinding.js, line 21

Public Properties

active : boolean

If binding is active and should be executed.

Default Value
  • true
Source code: core/SignalBinding.js, line 81

callCount : number

The number of times the handler function has been called.

Source code: core/SignalBinding.js, line 74

context : Object

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

Source code: core/SignalBinding.js, line 57

params :array | null

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

Type
  • array | null
Default Value
  • null
Source code: core/SignalBinding.js, line 88

Public 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 code: core/SignalBinding.js, line 117

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.

Parameters
Name Type Argument Description
paramsArr any[] <optional>

Array of parameters that should be passed to the listener.

Returns
any -

Value returned by the listener.

Source code: core/SignalBinding.js, line 90

getListener() → {function}

Returns
function -

Handler function bound to the signal.

Source code: core/SignalBinding.js, line 143

getSignal() → {Phaser.Signal}

Returns

Signal that listener is currently bound to.

Source code: core/SignalBinding.js, line 151

isBound() → {boolean}

Returns
boolean -

True if binding is still bound to the signal and has a listener.

Source code: core/SignalBinding.js, line 127

isOnce() → {boolean}

Returns
boolean -

If SignalBinding will only be executed once.

Source code: core/SignalBinding.js, line 135

toString() → {string}

Returns
string -

String representation of the object.

Source code: core/SignalBinding.js, line 170