Skip to content

Commit 8b939d7

Browse files
sammesamme
committed
Omit EmitterOpEmitConfig, EmitterOpUpdateConfig
1 parent 0b881e9 commit 8b939d7

2 files changed

Lines changed: 37 additions & 51 deletions

File tree

‎src/gameobjects/particles/EmitterOp.js‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,6 @@ var Wrap = require('../../math/Wrap');
3333
* @return {number} The new value of the property.
3434
*/
3535

36-
/**
37-
* Defines a value or an operation yielding a value, setting what a particle property will be at the START of the particle's life, on emit.
38-
* @typedef {float|float[]|EmitterOpOnEmitCallback|EmitterOpRandomConfig|EmitterOpRandomMinMaxConfig|EmitterOpRandomStartEndConfig|EmitterOpSteppedConfig|EmitterOpCustomEmitConfig} EmitterOpEmitConfig
39-
*
40-
* @see Phaser.GameObjects.Particles.Particle#fire
41-
*/
42-
43-
/**
44-
* Defines an operation yielding a value, updating a particle property for the duration of the particle's life.
45-
* @typedef {EmitterOpOnUpdateCallback|EmitterOpEaseConfig|EmitterOpCustomUpdateConfig} EmitterOpUpdateConfig
46-
*
47-
* @see Phaser.GameObjects.Particles.Particle#update
48-
*/
49-
5036
/**
5137
* Defines an operation yielding a random value within a range.
5238
* @typedef {object} EmitterOpRandomConfig

‎src/gameobjects/particles/ParticleEmitter.js‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -108,28 +108,28 @@ var Wrap = require('../../math/Wrap');
108108
* @property {float} [timeScale] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.
109109
* @property {boolean} [trackVisible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.
110110
* @property {boolean} [visible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.
111-
* @property {EmitterOpEmitConfig} [accelerationX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX} (emit only).
112-
* @property {EmitterOpEmitConfig} [accelerationY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY} (emit only).
113-
* @property {EmitterOpEmitConfig|EmitterOpUpdateConfig} [alpha] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#alpha}.
114-
* @property {EmitterOpEmitConfig} [angle] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#angle} (emit only)
115-
* @property {EmitterOpEmitConfig} [bounce] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce} (emit only).
116-
* @property {EmitterOpEmitConfig} [delay] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).
117-
* @property {EmitterOpEmitConfig} [lifespan] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).
118-
* @property {EmitterOpEmitConfig} [maxVelocityX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX} (emit only).
119-
* @property {EmitterOpEmitConfig} [maxVelocityY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY} (emit only).
120-
* @property {EmitterOpEmitConfig} [moveToX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX} (emit only).
121-
* @property {EmitterOpEmitConfig} [moveToY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY} (emit only).
122-
* @property {EmitterOpEmitConfig} [quantity] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).
123-
* @property {EmitterOpEmitConfig|EmitterOpUpdateConfig} [rotate] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#rotate}.
124-
* @property {EmitterOpEmitConfig|EmitterOpUpdateConfig} [scale] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.
125-
* @property {EmitterOpEmitConfig|EmitterOpUpdateConfig} [scaleX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleX}.
126-
* @property {EmitterOpEmitConfig|EmitterOpUpdateConfig} [scaleY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleY}.
127-
* @property {EmitterOpEmitConfig} [speed] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).
128-
* @property {EmitterOpEmitConfig} [speedX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).
129-
* @property {EmitterOpEmitConfig} [speedY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).
130-
* @property {EmitterOpEmitConfig} [tint] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tint}.
131-
* @property {EmitterOpEmitConfig} [x] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#x} (emit only).
132-
* @property {EmitterOpEmitConfig} [y] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#y} (emit only).
111+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [accelerationX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX} (emit only).
112+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [accelerationY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY} (emit only).
113+
* @property {float|float[]|EmitterOpOnUpdateCallback|object} [alpha] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#alpha}.
114+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [angle] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#angle} (emit only)
115+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [bounce] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce} (emit only).
116+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [delay] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).
117+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [lifespan] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).
118+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [maxVelocityX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX} (emit only).
119+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [maxVelocityY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY} (emit only).
120+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [moveToX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX} (emit only).
121+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [moveToY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY} (emit only).
122+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [quantity] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).
123+
* @property {float|float[]|EmitterOpOnUpdateCallback|object} [rotate] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#rotate}.
124+
* @property {float|float[]|EmitterOpOnUpdateCallback|object} [scale] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.
125+
* @property {float|float[]|EmitterOpOnUpdateCallback|object} [scaleX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleX}.
126+
* @property {float|float[]|EmitterOpOnUpdateCallback|object} [scaleY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#scaleY}.
127+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [speed] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).
128+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [speedX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).
129+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [speedY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).
130+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [tint] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tint}.
131+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [x] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#x} (emit only).
132+
* @property {float|float[]|EmitterOpOnEmitCallback|object} [y] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#y} (emit only).
133133
* @property {object} [emitZone] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.
134134
* @property {ParticleEmitterBounds|ParticleEmitterBoundsAlt} [bounds] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.
135135
* @property {object} [followOffset] - Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.
@@ -1175,8 +1175,8 @@ var ParticleEmitter = new Class({
11751175
* @method Phaser.GameObjects.Particles.ParticleEmitter#setPosition
11761176
* @since 3.0.0
11771177
*
1178-
* @param {EmitterOpEmitConfig} x - The x-coordinate of the particle origin.
1179-
* @param {EmitterOpEmitConfig} y - The y-coordinate of the particle origin.
1178+
* @param {float|float[]|EmitterOpOnEmitCallback|object} x - The x-coordinate of the particle origin.
1179+
* @param {float|float[]|EmitterOpOnEmitCallback|object} y - The y-coordinate of the particle origin.
11801180
*
11811181
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
11821182
*/
@@ -1233,7 +1233,7 @@ var ParticleEmitter = new Class({
12331233
* @method Phaser.GameObjects.Particles.ParticleEmitter#setSpeedX
12341234
* @since 3.0.0
12351235
*
1236-
* @param {EmitterOpEmitConfig} value - The speed, in pixels per second.
1236+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The speed, in pixels per second.
12371237
*
12381238
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
12391239
*/
@@ -1253,7 +1253,7 @@ var ParticleEmitter = new Class({
12531253
* @method Phaser.GameObjects.Particles.ParticleEmitter#setSpeedY
12541254
* @since 3.0.0
12551255
*
1256-
* @param {EmitterOpEmitConfig} value - The speed, in pixels per second.
1256+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The speed, in pixels per second.
12571257
*
12581258
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
12591259
*/
@@ -1276,7 +1276,7 @@ var ParticleEmitter = new Class({
12761276
* @method Phaser.GameObjects.Particles.ParticleEmitter#setSpeed
12771277
* @since 3.0.0
12781278
*
1279-
* @param {EmitterOpEmitConfig} value - The speed, in pixels per second.
1279+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The speed, in pixels per second.
12801280
*
12811281
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
12821282
*/
@@ -1297,7 +1297,7 @@ var ParticleEmitter = new Class({
12971297
* @method Phaser.GameObjects.Particles.ParticleEmitter#setScaleX
12981298
* @since 3.0.0
12991299
*
1300-
* @param {EmitterOpEmitConfig|EmitterOpUpdateConfig} value - The scale, relative to 1.
1300+
* @param {float|float[]|EmitterOpOnUpdateCallback|object} value - The scale, relative to 1.
13011301
*
13021302
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
13031303
*/
@@ -1314,7 +1314,7 @@ var ParticleEmitter = new Class({
13141314
* @method Phaser.GameObjects.Particles.ParticleEmitter#setScaleY
13151315
* @since 3.0.0
13161316
*
1317-
* @param {EmitterOpEmitConfig|EmitterOpUpdateConfig} value - The scale, relative to 1.
1317+
* @param {float|float[]|EmitterOpOnUpdateCallback|object} value - The scale, relative to 1.
13181318
*
13191319
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
13201320
*/
@@ -1331,7 +1331,7 @@ var ParticleEmitter = new Class({
13311331
* @method Phaser.GameObjects.Particles.ParticleEmitter#setScale
13321332
* @since 3.0.0
13331333
*
1334-
* @param {EmitterOpEmitConfig|EmitterOpUpdateConfig} value - The scale, relative to 1.
1334+
* @param {float|float[]|EmitterOpOnUpdateCallback|object} value - The scale, relative to 1.
13351335
*
13361336
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
13371337
*/
@@ -1402,7 +1402,7 @@ var ParticleEmitter = new Class({
14021402
* @method Phaser.GameObjects.Particles.ParticleEmitter#setAlpha
14031403
* @since 3.0.0
14041404
*
1405-
* @param {EmitterOpEmitConfig|EmitterOpUpdateConfig} value - A value between 0 (transparent) and 1 (opaque).
1405+
* @param {float|float[]|EmitterOpOnUpdateCallback|object} value - A value between 0 (transparent) and 1 (opaque).
14061406
*
14071407
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14081408
*/
@@ -1419,7 +1419,7 @@ var ParticleEmitter = new Class({
14191419
* @method Phaser.GameObjects.Particles.ParticleEmitter#setEmitterAngle
14201420
* @since 3.0.0
14211421
*
1422-
* @param {EmitterOpEmitConfig} value - The angle of the initial velocity of emitted particles.
1422+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The angle of the initial velocity of emitted particles.
14231423
*
14241424
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14251425
*/
@@ -1436,7 +1436,7 @@ var ParticleEmitter = new Class({
14361436
* @method Phaser.GameObjects.Particles.ParticleEmitter#setAngle
14371437
* @since 3.0.0
14381438
*
1439-
* @param {EmitterOpEmitConfig} value - The angle of the initial velocity of emitted particles.
1439+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The angle of the initial velocity of emitted particles.
14401440
*
14411441
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14421442
*/
@@ -1453,7 +1453,7 @@ var ParticleEmitter = new Class({
14531453
* @method Phaser.GameObjects.Particles.ParticleEmitter#setLifespan
14541454
* @since 3.0.0
14551455
*
1456-
* @param {EmitterOpEmitConfig} value - The particle lifespan, in ms.
1456+
* @param {float|float[]|EmitterOpOnEmitCallback|object} value - The particle lifespan, in ms.
14571457
*
14581458
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14591459
*/
@@ -1470,7 +1470,7 @@ var ParticleEmitter = new Class({
14701470
* @method Phaser.GameObjects.Particles.ParticleEmitter#setQuantity
14711471
* @since 3.0.0
14721472
*
1473-
* @param {EmitterOpEmitConfig} quantity - The number of particles to release at each flow cycle or explosion.
1473+
* @param {float|float[]|EmitterOpOnEmitCallback|object} quantity - The number of particles to release at each flow cycle or explosion.
14741474
*
14751475
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14761476
*/
@@ -1489,7 +1489,7 @@ var ParticleEmitter = new Class({
14891489
* @since 3.0.0
14901490
*
14911491
* @param {float} frequency - The time interval (>= 0) of each flow cycle, in ms; or -1 to put the emitter in explosion mode.
1492-
* @param {EmitterOpEmitConfig} [quantity] - The number of particles to release at each flow cycle or explosion.
1492+
* @param {float|float[]|EmitterOpOnEmitCallback|object} [quantity] - The number of particles to release at each flow cycle or explosion.
14931493
*
14941494
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
14951495
*/
@@ -1887,7 +1887,7 @@ var ParticleEmitter = new Class({
18871887
* @since 3.0.0
18881888
*
18891889
* @param {float} frequency - The time interval (>= 0) of each flow cycle, in ms.
1890-
* @param {EmitterOpEmitConfig} [count=1] - The number of particles to emit at each flow cycle.
1890+
* @param {float|float[]|EmitterOpOnEmitCallback|object} [count=1] - The number of particles to emit at each flow cycle.
18911891
*
18921892
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
18931893
*/

0 commit comments

Comments
 (0)