///
- This is an internal constructor and shouldn't be called by regular users.
*
- inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.
* @author Miller Medeiros
* @constructor
* @internal
* @name SignalBinding
* @param {Signal} signal Reference to Signal object that listener is currently bound to.
* @param {Function} listener Handler function bound to the signal.
* @param {boolean} isOnce If binding should be executed just once.
* @param {Object} [listenerContext] Context on which listener will be executed (object that should represent the `this` variable inside listener function).
* @param {Number} [priority] The priority level of the event listener. (default = 0).
*/
function SignalBinding(signal, listener, isOnce, listenerContext, priority) {
if (typeof priority === "undefined") { priority = 0; }
/**
* If binding is active and should be executed.
* @type boolean
*/
this.active = true;
/**
* Default parameters passed to listener during `Signal.dispatch` and `SignalBinding.execute`. (curried parameters)
* @type Array|null
*/
this.params = null;
this._listener = listener;
this._isOnce = isOnce;
this.context = listenerContext;
this._signal = signal;
this.priority = priority || 0;
}
/**
* 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.
* @param {Array} [paramsArr] Array of parameters that should be passed to the listener * @return {*} Value returned by the listener. */ SignalBinding.prototype.execute = function (paramsArr) { var handlerReturn; var params; if (this.active && !!this._listener) { params = this.params ? this.params.concat(paramsArr) : paramsArr; handlerReturn = this._listener.apply(this.context, params); if (this._isOnce) { this.detach(); } } return handlerReturn; }; /** * Detach binding from signal. * - alias to: mySignal.remove(myBinding.getListener()); * @return {Function|null} Handler function bound to the signal or `null` if binding was previously detached. */ SignalBinding.prototype.detach = function () { return this.isBound() ? this._signal.remove(this._listener, this.context) : null; }; /** * @return {Boolean} `true` if binding is still bound to the signal and have a listener. */ SignalBinding.prototype.isBound = function () { return (!!this._signal && !!this._listener); }; /** * @return {boolean} If SignalBinding will only be executed once. */ SignalBinding.prototype.isOnce = function () { return this._isOnce; }; /** * @return {Function} Handler function bound to the signal. */ SignalBinding.prototype.getListener = function () { return this._listener; }; /** * @return {Signal} Signal that listener is currently bound to. */ SignalBinding.prototype.getSignal = function () { return this._signal; }; /** * Delete instance properties * @private */ SignalBinding.prototype._destroy = function () { delete this._signal; delete this._listener; delete this.context; }; /** * @return {string} String representation of the object. */ SignalBinding.prototype.toString = function () { return '[SignalBinding isOnce:' + this._isOnce + ', isBound:' + this.isBound() + ', active:' + this.active + ']'; }; return SignalBinding; })(); Phaser.SignalBinding = SignalBinding; })(Phaser || (Phaser = {}));