Phaser API Documentation

  Version: 
Filter
Namespace: Events
Phaser.GameObjects.Particles.Events

Events

COMPLETE
Focus
Focus

Description:

The Particle Emitter Complete Event.

This event is dispatched when the final particle, emitted from a Particle Emitter that has been stopped, dies. Upon receipt of this event you know that no particles are still rendering at this point in time.

Listen for it on a Particle Emitter instance using ParticleEmitter.on('complete', listener).

Parameters:

name type description
emitter Phaser.GameObjects.Particles.ParticleEmitter

A reference to the Particle Emitter that just completed.

Focus
Focus
DEATH_ZONE
Focus
Focus

Description:

The Particle Emitter Death Zone Event.

This event is dispatched when a Death Zone kills a Particle instance.

Listen for it on a Particle Emitter instance using ParticleEmitter.on('deathzone', listener).

If you wish to know when the final particle is killed, see the COMPLETE event.

Parameters:

name type description
emitter Phaser.GameObjects.Particles.ParticleEmitter

A reference to the Particle Emitter that owns the Particle and Death Zone.

particle Phaser.GameObjects.Particles.Particle

The Particle that has been killed.

zone Phaser.GameObjects.Particles.Zones.DeathZone

The Death Zone that killed the particle.

Focus
Focus
EXPLODE
Focus
Focus

Description:

The Particle Emitter Explode Event.

This event is dispatched when a Particle Emitter explodes a set of particles.

Listen for it on a Particle Emitter instance using ParticleEmitter.on('explode', listener).

Parameters:

name type description
emitter Phaser.GameObjects.Particles.ParticleEmitter

A reference to the Particle Emitter that just completed.

particle Phaser.GameObjects.Particles.Particle

The most recently emitted Particle.

Focus
Focus
START
Focus
Focus

Description:

The Particle Emitter Start Event.

This event is dispatched when a Particle Emitter starts emission of particles.

Listen for it on a Particle Emitter instance using ParticleEmitter.on('start', listener).

Parameters:

name type description
emitter Phaser.GameObjects.Particles.ParticleEmitter

A reference to the Particle Emitter that just completed.

Since: 3.60.0
Focus
Focus
STOP
Focus
Focus

Description:

The Particle Emitter Stop Event.

This event is dispatched when a Particle Emitter is stopped. This can happen either when you directly call the ParticleEmitter.stop method, or if the emitter has been configured to stop after a set time via the duration property, or after a set number of particles via the stopAfter property.

Listen for it on a Particle Emitter instance using ParticleEmitter.on('stop', listener).

Note that just because the emitter has stopped, that doesn't mean there aren't still particles alive and rendering. It just means the emitter has stopped emitting particles.

If you wish to know when the final particle is killed, see the COMPLETE event.

Parameters:

name type description
emitter Phaser.GameObjects.Particles.ParticleEmitter

A reference to the Particle Emitter that just completed.

Since: 3.60.0
Focus
Focus