Phaser API Documentation

  Version: 
stop([kill])

Description:

Turns off the emitter and stops it from emitting further particles. Currently alive particles will remain active until they naturally expire unless you set the kill parameter to true.

Calling this method will emit the STOP event. When the final particle has expired the COMPLETE event will be emitted.

Parameters:

name type arguments Default description
kill boolean <optional> false

Kill all particles immediately (true), or leave them to die after their lifespan expires? (false, the default)

Returns:
Description:

This Particle Emitter.

Since: 3.11.0