Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 20:53:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6587 from PresentCreativeLLC/missing-particle-emitter-property

Browse source 
Added missing description of the anims property of the particle emitter for JSDoc
This commit is contained in:
Richard Davey 2023-09-07 13:19:17 +01:00 committed by GitHub
commit 18f5a73692
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1333,7 +1333,7 @@ var ParticleEmitter = new Class({
* @method Phaser.GameObjects.Particles.ParticleEmitter#setAnim
* @since 3.60.0
*
* @param {(array|string|Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig)} anims - One or more animations, or a configuration object.
* @param {(string|string[]|Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig)} anims - One or more animations, or a configuration object.
* @param {boolean} [pickRandom=true] - Whether animations should be assigned at random from `anims`.
* @param {number} [quantity=1] - The number of consecutive particles that will receive each animation.
*

8
src/gameobjects/particles/typedefs/ParticleEmitterAnimConfig.js Normal file
View file

@ -0,0 +1,8 @@
/**
* @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig
* @since 3.60.0
*
* @property {string|string[]} [anims] - One or more animations names.
* @property {boolean} [cycle] - Whether animations will be assigned consecutively (true) or at random (false).
* @property {number} [quantity] - The number of consecutive particles receiving each animation, when `cycle` is true.
*/

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

@ -58,6 +58,7 @@
* @property {object} [followOffset] - Assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.
* @property {number} [followOffset.x] - x coordinate of the offset.
* @property {number} [followOffset.y] - y coordinate of the offset.
* @property {string|string[]|Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig} [anim] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#anims}.
* @property {number|number[]|string|string[]|Phaser.Textures.Frame|Phaser.Textures.Frame[]|Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig} [frame] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.
* @property {string|Phaser.Textures.Frame} [texture] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#texture}. Overrides any texture already set on the Emitter.
* @property {number} [reserve] - Creates specified number of inactive particles and adds them to this emitter's pool. {@link Phaser.GameObjects.Particles.ParticleEmitter#reserve}