Skip to content

Commit 5018061

Browse files
committed
Add NumberTweenBuilderConfig type
1 parent c7af250 commit 5018061

3 files changed

Lines changed: 22 additions & 7 deletions

File tree

src/tweens/TweenManager.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,12 @@ var TweenManager = new Class({
243243
},
244244

245245
/**
246-
* Create a Tween and add it to the active Tween list.
246+
* Create a Number Tween and add it to the active Tween list.
247247
*
248248
* @method Phaser.Tweens.TweenManager#addCounter
249249
* @since 3.0.0
250250
*
251-
* @param {object} config - The configuration object for the Number Tween as per the {@link Phaser.Tweens.Builders.NumberTweenBuilder}.
251+
* @param {Phaser.Types.Tweens.NumberTweenBuilderConfig} config - The configuration object for the Number Tween.
252252
*
253253
* @return {Phaser.Tweens.Tween} The created Number Tween.
254254
*/

src/tweens/builders/NumberTweenBuilder.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ var Tween = require('../tween/Tween');
1515
var TweenData = require('../tween/TweenData');
1616

1717
/**
18-
* [description]
18+
* Creates a new Number Tween.
1919
*
2020
* @function Phaser.Tweens.Builders.NumberTweenBuilder
2121
* @since 3.0.0
2222
*
23-
* @param {(Phaser.Tweens.TweenManager|Phaser.Tweens.Timeline)} parent - [description]
24-
* @param {object} config - [description]
25-
* @param {Phaser.Types.Tweens.TweenConfigDefaults} defaults - [description]
23+
* @param {(Phaser.Tweens.TweenManager|Phaser.Tweens.Timeline)} parent - The owner of the new Tween.
24+
* @param {Phaser.Types.Tweens.NumberTweenBuilderConfig} config - Configuration for the new Tween.
25+
* @param {Phaser.Types.Tweens.TweenConfigDefaults} defaults - Tween configuration defaults.
2626
*
27-
* @return {Phaser.Tweens.Tween} [description]
27+
* @return {Phaser.Tweens.Tween} The new tween.
2828
*/
2929
var NumberTweenBuilder = function (parent, config, defaults)
3030
{
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/**
2+
* @typedef {object} Phaser.Types.Tweens.NumberTweenBuilderConfig
3+
* @since 3.18.0
4+
*
5+
* @property {number} [from=0] - The start number.
6+
* @property {number} [to=1] - The end number.
7+
* @property {number} [delay=0] - The number of milliseconds to delay before the tween will start.
8+
* @property {number} [duration=1000] - The duration of the tween in milliseconds.
9+
* @property {string} [ease='Power0'] - The easing equation to use for the tween.
10+
* @property {array} [easeParams] - Optional easing parameters.
11+
* @property {number} [hold=0] - The number of milliseconds to hold the tween for before yoyo'ing.
12+
* @property {number} [repeat=0] - The number of times to repeat the tween.
13+
* @property {number} [repeatDelay=0] - The number of milliseconds to pause before a tween will repeat.
14+
* @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.
15+
*/

0 commit comments

Comments
 (0)