TS def improvements

This commit is contained in:
J.C 2020-03-02 20:14:25 +08:00
parent 88b088b6a2
commit d8dc7fb4d7
7 changed files with 13 additions and 15 deletions

View file

@ -28,7 +28,7 @@ var Events = require('./events');
* @since 3.0.0
*
* @param {object} parent - The object that this DataManager belongs to.
* @param {Phaser.Events.EventEmitter} eventEmitter - The DataManager's event emitter.
* @param {Phaser.Events.EventEmitter} [eventEmitter] - The DataManager's event emitter.
*/
var DataManager = new Class({

View file

@ -7,7 +7,7 @@
/**
* Linear easing (no variation).
*
* @function Phaser.Math.Easing.Linear.Linear
* @function Phaser.Math.Easing.Linear
* @since 3.0.0
*
* @param {number} v - The value to be tweened.

View file

@ -4,8 +4,4 @@
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* @namespace Phaser.Math.Easing.Linear
*/
module.exports = require('./Linear');

View file

@ -12,10 +12,10 @@
* @property {number} [repeat=0] - The number of times to repeat the tween.
* @property {number} [repeatDelay=0] - The number of milliseconds to pause before a tween will repeat.
* @property {boolean} [yoyo=false] - Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.
* @property {number|function|object|array} [offset=null] - Used when the Tween is part of a Timeline.
* @property {number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
* @property {number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.
* @property {number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
* @property {string|number|function|object|array} [offset=null] - Used when the Tween is part of a Timeline.
* @property {string|number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
* @property {string|number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.
* @property {string|number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
* @property {boolean} [paused=false] - Does the tween start in a paused state (true) or playing (false)?
* @property {boolean} [useFrames=false] - Use frames or milliseconds?
* @property {any} [callbackScope] - Scope (this) for the callbacks. The default scope is the tween.

View file

@ -13,10 +13,10 @@
* @property {boolean} [yoyo=false] - Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.
* @property {boolean} [flipX=false] - Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.
* @property {boolean} [flipY=false] - Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.
* @property {number|function|object|array} [offset=null] - Used when the Tween is part of a Timeline.
* @property {number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
* @property {number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.
* @property {number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
* @property {string|number|function|object|array} [offset=null] - Used when the Tween is part of a Timeline.
* @property {string|number|function|object|array} [completeDelay=0] - The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
* @property {string|number|function|object|array} [loop=0] - The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.
* @property {string|number|function|object|array} [loopDelay=0] - The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
* @property {boolean} [paused=false] - Does the tween start in a paused state (true) or playing (false)?
* @property {Object.<string,(number|string|Phaser.Types.Tweens.GetEndCallback|Phaser.Types.Tweens.TweenPropConfig)>} [props] - The properties to tween.
* @property {boolean} [useFrames=false] - Use frames or milliseconds?

View file

@ -16,6 +16,8 @@ var IsPlainObject = require('./IsPlainObject');
* @function Phaser.Utils.Objects.Extend
* @since 3.0.0
*
* @param {...*} [args] - The objects that will be mixed.
*
* @return {object} The extended object.
*/
var Extend = function ()

View file

@ -27,7 +27,7 @@
* @function Phaser.Utils.String.Pad
* @since 3.0.0
*
* @param {string} str - The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.
* @param {string|number|object} str - The target string. `toString()` will be called on the string, which means you can also pass in common data types like numbers.
* @param {integer} [len=0] - The number of characters to be added.
* @param {string} [pad=" "] - The string to pad it out with (defaults to a space).
* @param {integer} [dir=3] - The direction dir = 1 (left), 2 (right), 3 (both).