class: ParticleEmitters

[14:14] static extends: object

Helper for FXGL's ParticleEmitters static catalog. Each method returns a pre-configured ParticleEmitter for a common visual effect (fire, explosion, smoke, sparks, rain, snow, etc.). Override individual fields on the returned emitter to tune.

Methods

newFireEmitter ()

Returns a pre-configured fire emitter.
- @r A ParticleEmitter wrapper.
newExplosionEmitter (int Radius)

Returns a pre-configured explosion emitter centered on the particle source. Particles travel outward to the given radius before fading out.
- @p Radius is the explosion radius in pixels.
- @r A ParticleEmitter wrapper.
newSmokeEmitter ()

Returns a pre-configured smoke emitter.
- @r A ParticleEmitter wrapper.
newSparkEmitter ()

Returns a pre-configured sparks emitter.
- @r A ParticleEmitter wrapper.
newFireEmitterWide (int Width)

Returns a pre-configured fire emitter sized to a width. Used for wall- or curtain-style fires that span a region.
- @p Width is the emitter width in pixels.
- @r A ParticleEmitter wrapper.
newImplosionEmitter ()

Returns a pre-configured implosion emitter.
- @r A ParticleEmitter wrapper.
newRainEmitter (int Width)

Returns a pre-configured rain emitter spanning the given width.
- @p Width is the emitter width in pixels.
- @r A ParticleEmitter wrapper.