Skip to content

Commit 1fd71ae

Browse files
JasonHKJasonHK
committed
Fixed this return types fro Phaser.GameObjects.Particles.ParticleEmitter 
1 parent 4df2179 commit 1fd71ae

2 files changed

Lines changed: 76 additions & 76 deletions

File tree

‎src/gameobjects/particles/ParticleEmitter.js‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -770,7 +770,7 @@ var ParticleEmitter = new Class({
770770
*
771771
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} config - Settings for this emitter.
772772
*
773-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
773+
* @return {this} This Particle Emitter.
774774
*/
775775
fromJSON: function (config)
776776
{
@@ -927,7 +927,7 @@ var ParticleEmitter = new Class({
927927
* @param {number} [offsetY=0] - Vertical offset of the particle origin from the Game Object.
928928
* @param {boolean} [trackVisible=false] - Whether the emitter's visible state will track the target's visible state.
929929
*
930-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
930+
* @return {this} This Particle Emitter.
931931
*/
932932
startFollow: function (target, offsetX, offsetY, trackVisible)
933933
{
@@ -948,7 +948,7 @@ var ParticleEmitter = new Class({
948948
* @method Phaser.GameObjects.Particles.ParticleEmitter#stopFollow
949949
* @since 3.0.0
950950
*
951-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
951+
* @return {this} This Particle Emitter.
952952
*/
953953
stopFollow: function ()
954954
{
@@ -1009,7 +1009,7 @@ var ParticleEmitter = new Class({
10091009
* @param {boolean} [pickRandom=true] - Whether frames should be assigned at random from `frames`.
10101010
* @param {integer} [quantity=1] - The number of consecutive particles that will receive each frame.
10111011
*
1012-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1012+
* @return {this} This Particle Emitter.
10131013
*/
10141014
setFrame: function (frames, pickRandom, quantity)
10151015
{
@@ -1064,7 +1064,7 @@ var ParticleEmitter = new Class({
10641064
*
10651065
* @param {boolean} [value=true] - Radial mode (true) or point mode (true).
10661066
*
1067-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1067+
* @return {this} This Particle Emitter.
10681068
*/
10691069
setRadial: function (value)
10701070
{
@@ -1085,7 +1085,7 @@ var ParticleEmitter = new Class({
10851085
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} x - The x-coordinate of the particle origin.
10861086
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} y - The y-coordinate of the particle origin.
10871087
*
1088-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1088+
* @return {this} This Particle Emitter.
10891089
*/
10901090
setPosition: function (x, y)
10911091
{
@@ -1108,7 +1108,7 @@ var ParticleEmitter = new Class({
11081108
* @param {number} width - The width of the boundary.
11091109
* @param {number} height - The height of the boundary.
11101110
*
1111-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1111+
* @return {this} This Particle Emitter.
11121112
*/
11131113
setBounds: function (x, y, width, height)
11141114
{
@@ -1143,7 +1143,7 @@ var ParticleEmitter = new Class({
11431143
*
11441144
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The speed, in pixels per second.
11451145
*
1146-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1146+
* @return {this} This Particle Emitter.
11471147
*/
11481148
setSpeedX: function (value)
11491149
{
@@ -1164,7 +1164,7 @@ var ParticleEmitter = new Class({
11641164
*
11651165
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The speed, in pixels per second.
11661166
*
1167-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1167+
* @return {this} This Particle Emitter.
11681168
*/
11691169
setSpeedY: function (value)
11701170
{
@@ -1188,7 +1188,7 @@ var ParticleEmitter = new Class({
11881188
*
11891189
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The speed, in pixels per second.
11901190
*
1191-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1191+
* @return {this} This Particle Emitter.
11921192
*/
11931193
setSpeed: function (value)
11941194
{
@@ -1209,7 +1209,7 @@ var ParticleEmitter = new Class({
12091209
*
12101210
* @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - The scale, relative to 1.
12111211
*
1212-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1212+
* @return {this} This Particle Emitter.
12131213
*/
12141214
setScaleX: function (value)
12151215
{
@@ -1226,7 +1226,7 @@ var ParticleEmitter = new Class({
12261226
*
12271227
* @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - The scale, relative to 1.
12281228
*
1229-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1229+
* @return {this} This Particle Emitter.
12301230
*/
12311231
setScaleY: function (value)
12321232
{
@@ -1243,7 +1243,7 @@ var ParticleEmitter = new Class({
12431243
*
12441244
* @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - The scale, relative to 1.
12451245
*
1246-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1246+
* @return {this} This Particle Emitter.
12471247
*/
12481248
setScale: function (value)
12491249
{
@@ -1261,7 +1261,7 @@ var ParticleEmitter = new Class({
12611261
*
12621262
* @param {number} value - Acceleration due to gravity, in pixels per second squared.
12631263
*
1264-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1264+
* @return {this} This Particle Emitter.
12651265
*/
12661266
setGravityX: function (value)
12671267
{
@@ -1278,7 +1278,7 @@ var ParticleEmitter = new Class({
12781278
*
12791279
* @param {number} value - Acceleration due to gravity, in pixels per second squared.
12801280
*
1281-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1281+
* @return {this} This Particle Emitter.
12821282
*/
12831283
setGravityY: function (value)
12841284
{
@@ -1296,7 +1296,7 @@ var ParticleEmitter = new Class({
12961296
* @param {number} x - Horizontal acceleration due to gravity, in pixels per second squared.
12971297
* @param {number} y - Vertical acceleration due to gravity, in pixels per second squared.
12981298
*
1299-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1299+
* @return {this} This Particle Emitter.
13001300
*/
13011301
setGravity: function (x, y)
13021302
{
@@ -1314,7 +1314,7 @@ var ParticleEmitter = new Class({
13141314
*
13151315
* @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - A value between 0 (transparent) and 1 (opaque).
13161316
*
1317-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1317+
* @return {this} This Particle Emitter.
13181318
*/
13191319
setAlpha: function (value)
13201320
{
@@ -1331,7 +1331,7 @@ var ParticleEmitter = new Class({
13311331
*
13321332
* @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - A value between 0 and 0xffffff.
13331333
*
1334-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1334+
* @return {this} This Particle Emitter.
13351335
*/
13361336
setTint: function (value)
13371337
{
@@ -1348,7 +1348,7 @@ var ParticleEmitter = new Class({
13481348
*
13491349
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The angle of the initial velocity of emitted particles.
13501350
*
1351-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1351+
* @return {this} This Particle Emitter.
13521352
*/
13531353
setEmitterAngle: function (value)
13541354
{
@@ -1365,7 +1365,7 @@ var ParticleEmitter = new Class({
13651365
*
13661366
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The angle of the initial velocity of emitted particles.
13671367
*
1368-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1368+
* @return {this} This Particle Emitter.
13691369
*/
13701370
setAngle: function (value)
13711371
{
@@ -1382,7 +1382,7 @@ var ParticleEmitter = new Class({
13821382
*
13831383
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The particle lifespan, in ms.
13841384
*
1385-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1385+
* @return {this} This Particle Emitter.
13861386
*/
13871387
setLifespan: function (value)
13881388
{
@@ -1399,7 +1399,7 @@ var ParticleEmitter = new Class({
13991399
*
14001400
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} quantity - The number of particles to release at each flow cycle or explosion.
14011401
*
1402-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1402+
* @return {this} This Particle Emitter.
14031403
*/
14041404
setQuantity: function (quantity)
14051405
{
@@ -1418,7 +1418,7 @@ var ParticleEmitter = new Class({
14181418
* @param {number} frequency - The time interval (>= 0) of each flow cycle, in ms; or -1 to put the emitter in explosion mode.
14191419
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [quantity] - The number of particles to release at each flow cycle or explosion.
14201420
*
1421-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1421+
* @return {this} This Particle Emitter.
14221422
*/
14231423
setFrequency: function (frequency, quantity)
14241424
{
@@ -1446,7 +1446,7 @@ var ParticleEmitter = new Class({
14461446
*
14471447
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig|Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig} [zoneConfig] - An object describing the zone, or `undefined` to remove any current emit zone.
14481448
*
1449-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1449+
* @return {this} This Particle Emitter.
14501450
*/
14511451
setEmitZone: function (zoneConfig)
14521452
{
@@ -1495,7 +1495,7 @@ var ParticleEmitter = new Class({
14951495
*
14961496
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig} [zoneConfig] - An object describing the zone, or `undefined` to remove any current death zone.
14971497
*
1498-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1498+
* @return {this} This Particle Emitter.
14991499
*/
15001500
setDeathZone: function (zoneConfig)
15011501
{
@@ -1531,7 +1531,7 @@ var ParticleEmitter = new Class({
15311531
*
15321532
* @param {integer} particleCount - The number of particles to create.
15331533
*
1534-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1534+
* @return {this} This Particle Emitter.
15351535
*/
15361536
reserve: function (particleCount)
15371537
{
@@ -1606,7 +1606,7 @@ var ParticleEmitter = new Class({
16061606
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.
16071607
* @param {*} [context] - The calling context.
16081608
*
1609-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1609+
* @return {this} This Particle Emitter.
16101610
*/
16111611
onParticleEmit: function (callback, context)
16121612
{
@@ -1638,7 +1638,7 @@ var ParticleEmitter = new Class({
16381638
* @param {Phaser.Types.GameObjects.Particles.ParticleDeathCallback} callback - The function.
16391639
* @param {*} [context] - The function's calling context.
16401640
*
1641-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1641+
* @return {this} This Particle Emitter.
16421642
*/
16431643
onParticleDeath: function (callback, context)
16441644
{
@@ -1667,7 +1667,7 @@ var ParticleEmitter = new Class({
16671667
* @method Phaser.GameObjects.Particles.ParticleEmitter#killAll
16681668
* @since 3.0.0
16691669
*
1670-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1670+
* @return {this} This Particle Emitter.
16711671
*/
16721672
killAll: function ()
16731673
{
@@ -1691,7 +1691,7 @@ var ParticleEmitter = new Class({
16911691
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.
16921692
* @param {*} context - The function's calling context.
16931693
*
1694-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1694+
* @return {this} This Particle Emitter.
16951695
*/
16961696
forEachAlive: function (callback, context)
16971697
{
@@ -1716,7 +1716,7 @@ var ParticleEmitter = new Class({
17161716
* @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.
17171717
* @param {*} context - The function's calling context.
17181718
*
1719-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1719+
* @return {this} This Particle Emitter.
17201720
*/
17211721
forEachDead: function (callback, context)
17221722
{
@@ -1743,7 +1743,7 @@ var ParticleEmitter = new Class({
17431743
* @method Phaser.GameObjects.Particles.ParticleEmitter#start
17441744
* @since 3.0.0
17451745
*
1746-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1746+
* @return {this} This Particle Emitter.
17471747
*/
17481748
start: function ()
17491749
{
@@ -1760,7 +1760,7 @@ var ParticleEmitter = new Class({
17601760
* @method Phaser.GameObjects.Particles.ParticleEmitter#stop
17611761
* @since 3.11.0
17621762
*
1763-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1763+
* @return {this} This Particle Emitter.
17641764
*/
17651765
stop: function ()
17661766
{
@@ -1775,7 +1775,7 @@ var ParticleEmitter = new Class({
17751775
* @method Phaser.GameObjects.Particles.ParticleEmitter#pause
17761776
* @since 3.0.0
17771777
*
1778-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1778+
* @return {this} This Particle Emitter.
17791779
*/
17801780
pause: function ()
17811781
{
@@ -1790,7 +1790,7 @@ var ParticleEmitter = new Class({
17901790
* @method Phaser.GameObjects.Particles.ParticleEmitter#resume
17911791
* @since 3.0.0
17921792
*
1793-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1793+
* @return {this} This Particle Emitter.
17941794
*/
17951795
resume: function ()
17961796
{
@@ -1805,7 +1805,7 @@ var ParticleEmitter = new Class({
18051805
* @method Phaser.GameObjects.Particles.ParticleEmitter#remove
18061806
* @since 3.22.0
18071807
*
1808-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1808+
* @return {this} This Particle Emitter.
18091809
*/
18101810
remove: function ()
18111811
{
@@ -1820,7 +1820,7 @@ var ParticleEmitter = new Class({
18201820
* @method Phaser.GameObjects.Particles.ParticleEmitter#depthSort
18211821
* @since 3.0.0
18221822
*
1823-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1823+
* @return {this} This Particle Emitter.
18241824
*/
18251825
depthSort: function ()
18261826
{
@@ -1840,7 +1840,7 @@ var ParticleEmitter = new Class({
18401840
* @param {number} frequency - The time interval (>= 0) of each flow cycle, in ms.
18411841
* @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [count=1] - The number of particles to emit at each flow cycle.
18421842
*
1843-
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
1843+
* @return {this} This Particle Emitter.
18441844
*/
18451845
flow: function (frequency, count)
18461846
{

0 commit comments

Comments
 (0)