-
Notifications
You must be signed in to change notification settings - Fork 2
Particle system documentation
Peter Crew edited this page Jan 4, 2019
·
2 revisions
This page covers the ParticleSystem
class, along with all of the classes for particle spawn shapes.
This class represents a system of particles, and is responsible for detailing how the particles behave.
The constructor takes a single JavaScript object with the following properties:
Name | Type | Required? | Description |
---|---|---|---|
texture |
ParticleTexture |
Only if colour and additive are not provided. |
The texture for the particle texture atlas that should be used. |
colour |
Vector3f |
Only if texture is not provided. |
The colour of the particle, with normalised values (RGB is from 0-1). |
additive |
boolean |
Only if texture is not provided. |
True if additive blending should be used. |
spawn |
ParticleSpawn |
Yes | The spawn shape of the particles. |
rate |
float |
Yes | The number of particles spawned per second. |
speed |
float |
Yes | The average speed of each spawned particle. |
gravity |
float |
Yes | How much gravity affects each particle (1 is standard gravity). |
life |
float |
Yes | The average number of seconds that the particle is alive for. |
scale |
float |
Yes | The average scale of each particle. |
Thanks for visiting this wiki. Don't forget to check out Equilinox!
The wiki and the modding framework are still heavily under development, so not all content is available yet.