ParticleEffect

1.5.0+

Wrapper around a particle effect resource.

For more information about how to create particle effects, have a look at the ParticleEffectManager class.

Note: Particle effects are per-engine, they can thus be shared by multiple scenes.

Properties

• .maxCount

Methods

• .destroy() ⇒ void
• .toString() ⇒ string

---

Properties

.maxCount: number

Maximum number of particles.

---

---

Methods

.destroy() ⇒ void

Destroy and free the particle effect memory.

It is best practice to set the particle effect variable to null after calling destroy to prevent accidental use:

  particleEffect.destroy();
  particleEffect = null;

Accessing the particle effect after destruction behaves like accessing an empty particle effect.

---

.toString() ⇒ string

---