Phaser API Documentation

  Version: 
particles(config, [addToScene])

Description:

Creates a new Particle Emitter Game Object and returns it.

Prior to Phaser v3.60 this function would create a ParticleEmitterManager. These were removed in v3.60 and replaced with creating a ParticleEmitter instance directly. Please see the updated function parameters and class documentation for more details.

Note: This method will only be available if the Particles Game Object has been built into Phaser.

Parameters:

name type arguments description
config Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig

The configuration object this Game Object will use to create itself.

addToScene boolean <optional>

Add this Game Object to the Scene after creating it? If set this argument overrides the add property in the config object.

Returns:
Description:

The Game Object that was created.