diff --git a/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js b/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js index 9726ad808..e2dc4d70e 100644 --- a/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js +++ b/src/gameobjects/particles/typedefs/ParticleEmitterConfig.js @@ -2,7 +2,7 @@ * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterConfig * @since 3.0.0 * - * @property {boolean} [active] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}. + * @property {boolean} [active] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}. Setting this to false will stop the emitter from running at all. If you just wish to stop particles from emitting, set `emitting` property instead. * @property {Phaser.BlendModes|string} [blendMode] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}. * @property {*} [callbackScope] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}. * @property {boolean} [collideBottom] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.