mirror of
https://github.com/wassname/phaser.git
synced 2026-08-15 12:45:11 +08:00
Updated documentation.
This commit is contained in:
@@ -70,7 +70,6 @@ Phaser.Filter.prototype = {
|
||||
/**
|
||||
* Should be over-ridden.
|
||||
* @method Phaser.Filter#init
|
||||
* @param {...}
|
||||
*/
|
||||
init: function () {
|
||||
// This should be over-ridden. Will receive a variable number of arguments.
|
||||
|
||||
+7
-7
@@ -13,13 +13,13 @@
|
||||
Phaser.Signal = function () {
|
||||
|
||||
/**
|
||||
* @property {Array.<Phaser.SignalBinding>} _bindings - Description.
|
||||
* @property {Array.<Phaser.SignalBinding>} _bindings - Internal variable.
|
||||
* @private
|
||||
*/
|
||||
this._bindings = [];
|
||||
|
||||
/**
|
||||
* @property {Description} _prevParams - Description.
|
||||
* @property {any} _prevParams - Internal variable.
|
||||
* @private
|
||||
*/
|
||||
this._prevParams = null;
|
||||
@@ -28,7 +28,7 @@ Phaser.Signal = function () {
|
||||
var self = this;
|
||||
|
||||
/**
|
||||
* @property {Description} dispatch - Description.
|
||||
* @property {function} dispatch - The dispatch function is what sends the Signal out.
|
||||
*/
|
||||
this.dispatch = function(){
|
||||
Phaser.Signal.prototype.dispatch.apply(self, arguments);
|
||||
@@ -63,7 +63,7 @@ Phaser.Signal.prototype = {
|
||||
/**
|
||||
* @method Phaser.Signal#validateListener
|
||||
* @param {function} listener - Signal handler function.
|
||||
* @param {Description} fnName - Description.
|
||||
* @param {string} fnName - Function name.
|
||||
* @private
|
||||
*/
|
||||
validateListener: function (listener, fnName) {
|
||||
@@ -222,7 +222,7 @@ Phaser.Signal.prototype = {
|
||||
|
||||
/**
|
||||
* Stop propagation of the event, blocking the dispatch to next listeners on the queue.
|
||||
* <p><strong>IMPORTANT:</strong> should be called only during signal dispatch, calling it before/after dispatch won't affect signal broadcast.</p>
|
||||
* IMPORTANT: should be called only during signal dispatch, calling it before/after dispatch won't affect signal broadcast.
|
||||
* @see Signal.prototype.disable
|
||||
*
|
||||
* @method Phaser.Signal#halt
|
||||
@@ -235,7 +235,7 @@ Phaser.Signal.prototype = {
|
||||
* Dispatch/Broadcast Signal to all listeners added to the queue.
|
||||
*
|
||||
* @method Phaser.Signal#dispatch
|
||||
* @param {...} [params] - Parameters that should be passed to each handler.
|
||||
* @param {any} [params] - Parameters that should be passed to each handler.
|
||||
*/
|
||||
dispatch: function () {
|
||||
|
||||
@@ -280,7 +280,7 @@ Phaser.Signal.prototype = {
|
||||
|
||||
/**
|
||||
* Remove all bindings from signal and destroy any reference to external objects (destroy Signal object).
|
||||
* <p><strong>IMPORTANT:</strong> calling any method on the signal instance after calling dispose will throw errors.</p>
|
||||
* IMPORTANT: calling any method on the signal instance after calling dispose will throw errors.
|
||||
*
|
||||
* @method Phaser.Signal#dispose
|
||||
*/
|
||||
|
||||
@@ -8,15 +8,15 @@
|
||||
* Phaser.SignalBinding
|
||||
*
|
||||
* Object that represents a binding between a Signal and a listener function.
|
||||
* <br />- <strong>This is an internal constructor and shouldn't be called by regular users.</strong>
|
||||
* <br />- inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.
|
||||
* 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.
|
||||
*
|
||||
* @class Phaser.SignalBinding
|
||||
* @name SignalBinding
|
||||
* @author Miller Medeiros http://millermedeiros.github.com/js-signals/
|
||||
* @constructor
|
||||
* @inner
|
||||
* @param {Signal} signal - Reference to Signal object that listener is currently bound to.
|
||||
* @param {Phaser.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).
|
||||
@@ -43,7 +43,7 @@ Phaser.SignalBinding = function (signal, listener, isOnce, listenerContext, prio
|
||||
this.context = listenerContext;
|
||||
|
||||
/**
|
||||
* @property {Signal} _signal - Reference to Signal object that listener is currently bound to.
|
||||
* @property {Phaser.Signal} _signal - Reference to Signal object that listener is currently bound to.
|
||||
* @private
|
||||
*/
|
||||
this._signal = signal;
|
||||
@@ -74,10 +74,10 @@ Phaser.SignalBinding.prototype = {
|
||||
|
||||
/**
|
||||
* Call listener passing arbitrary parameters.
|
||||
* <p>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.</p>
|
||||
* 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.
|
||||
* @method Phaser.SignalBinding#execute
|
||||
* @param {array} [paramsArr] - Array of parameters that should be passed to the listener.
|
||||
* @return {Description} Value returned by the listener.
|
||||
* @return {any} Value returned by the listener.
|
||||
*/
|
||||
execute: function (paramsArr) {
|
||||
|
||||
@@ -100,7 +100,7 @@ Phaser.SignalBinding.prototype = {
|
||||
|
||||
/**
|
||||
* Detach binding from signal.
|
||||
* <p>alias to: @see mySignal.remove(myBinding.getListener());
|
||||
* alias to: @see mySignal.remove(myBinding.getListener());
|
||||
* @method Phaser.SignalBinding#detach
|
||||
* @return {function|null} Handler function bound to the signal or `null` if binding was previously detached.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user