Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-23 11:33:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: add Phaser.Types.GameObjects.Particles.ParticleClassConstructor

Browse source 
Fixes #5731 ?
This commit is contained in:
samme 2021-10-13 13:23:31 -07:00
parent 52e402e14e
commit ba5e4ffab7
3 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/gameobjects/particles/ParticleEmitter.js
View file

@ -167,7 +167,7 @@ var ParticleEmitter = new Class({
* The Particle Class which will be emitted by this Emitter. * The Particle Class which will be emitted by this Emitter.
* *
* @name Phaser.GameObjects.Particles.ParticleEmitter#particleClass * @name Phaser.GameObjects.Particles.ParticleEmitter#particleClass
* @type {Phaser.GameObjects.Particles.Particle} * @type {Phaser.Types.GameObjects.Particles.ParticleClassConstructor}
* @default Phaser.GameObjects.Particles.Particle * @default Phaser.GameObjects.Particles.Particle
* @since 3.0.0 * @since 3.0.0
*/ */

6
src/gameobjects/particles/typedefs/ParticleClassConstructor.js Normal file
View file

@ -0,0 +1,6 @@
/**
* @callback Phaser.Types.GameObjects.Particles.ParticleClassConstructor
* @since 3.0.0
*
* @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - The Emitter to which this Particle belongs.
*/

2
src/gameobjects/particles/typedefs/ParticleEmitterConfig.js
View file

@ -21,7 +21,7 @@
* @property {string} [name] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}. * @property {string} [name] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.
* @property {boolean} [on] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#on}. * @property {boolean} [on] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#on}.
* @property {boolean} [particleBringToTop] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}. * @property {boolean} [particleBringToTop] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.
* @property {Phaser.GameObjects.Particles.Particle} [particleClass] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}. * @property {Phaser.Types.GameObjects.Particles.ParticleClassConstructor} [particleClass] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.
* @property {boolean} [radial] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}. * @property {boolean} [radial] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.
* @property {number} [timeScale] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}. * @property {number} [timeScale] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.
* @property {boolean} [trackVisible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}. * @property {boolean} [trackVisible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.