Phaser API Documentation

  Version: 
ParticleEmitterConfig
Properties:
name type arguments description
active boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#active.

blendMode string | Phaser.BlendModes <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#blendMode.

callbackScope * <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope and Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope.

collideBottom boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideBottom.

collideLeft boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideLeft.

collideRight boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideRight.

collideTop boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideTop.

deathCallback function <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallback.

deathCallbackScope * <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope.

emitCallback function <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#emitCallback.

emitCallbackScope * <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope.

follow Phaser.GameObjects.GameObject <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#follow.

frequency number <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#frequency.

gravityX number <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#gravityX.

gravityY number <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#gravityY.

maxParticles number <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxParticles.

name string <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#name.

on boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#on.

particleBringToTop boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop.

particleClass Phaser.GameObjects.Particles.Particle <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleClass.

radial boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#radial.

timeScale number <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#timeScale.

trackVisible boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#trackVisible.

visible boolean <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#visible.

accelerationX Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#accelerationX (emit only).

accelerationY Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#accelerationY (emit only).

alpha Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#alpha.

angle Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#angle (emit only).

bounce Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#bounce (emit only).

delay Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#delay (emit only).

lifespan Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#lifespan (emit only).

maxVelocityX Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX (emit only).

maxVelocityY Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY (emit only).

moveToX Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#moveToX (emit only).

moveToY Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#moveToY (emit only).

quantity Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#quantity (emit only).

rotate Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#rotate.

scale Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

As Phaser.GameObjects.Particles.ParticleEmitter#setScale.

scaleX Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#scaleX.

scaleY Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#scaleY.

speed Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

As Phaser.GameObjects.Particles.ParticleEmitter#setSpeed (emit only).

speedX Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#speedX (emit only).

speedY Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#speedY (emit only).

tint Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#tint.

x Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#x (emit only).

y Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#y (emit only).

emitZone Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig | Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig <optional>

As Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone.

deathZone Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig <optional>

As Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone.

bounds Phaser.Types.GameObjects.Particles.ParticleEmitterBounds | Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt <optional>

As Phaser.GameObjects.Particles.ParticleEmitter#setBounds.

followOffset object <optional>

Assigns to Phaser.GameObjects.Particles.ParticleEmitter#followOffset.

followOffset.x number <optional>

x-coordinate of the offset.

followOffset.y number <optional>

y-coordinate of the offset.

frame number | Array.<number> | string | Array.<string> | Phaser.Textures.Frame | Array.<Phaser.Textures.Frame> | Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig <optional>

Sets Phaser.GameObjects.Particles.ParticleEmitter#frames.

reserve number <optional>

Creates specified number of inactive particles and adds them to this emitter's pool. Phaser.GameObjects.Particles.ParticleEmitter#reserve

Type:
object