Header menu logo Nu

ParticleSystem Type

A particle system. TODO: consider making this an abstract data type?

Record fields

Record Field Description

Emitters

Full Usage: Emitters

Field type: Map<string, Emitter>
Field type: Map<string, Emitter>

Static members

Static member Description

ParticleSystem.add emitterId emitter particleSystem

Full Usage: ParticleSystem.add emitterId emitter particleSystem

Parameters:
Returns: ParticleSystem

Add an emitter to the particle system.

emitterId : string
emitter : Emitter
particleSystem : ParticleSystem
Returns: ParticleSystem

ParticleSystem.empty

Full Usage: ParticleSystem.empty

Returns: ParticleSystem

The empty particle system.

Returns: ParticleSystem

ParticleSystem.getAlive time particleSystem

Full Usage: ParticleSystem.getAlive time particleSystem

Parameters:
Returns: bool

Whether the particle system is alive at the given time.

time : GameTime
particleSystem : ParticleSystem
Returns: bool

ParticleSystem.remove emitterId particleSystem

Full Usage: ParticleSystem.remove emitterId particleSystem

Parameters:
Returns: ParticleSystem

Remove an emitter from the particle system.

emitterId : string
particleSystem : ParticleSystem
Returns: ParticleSystem

ParticleSystem.run delta time particleSystem

Full Usage: ParticleSystem.run delta time particleSystem

Parameters:
Returns: ParticleSystem * Output

Run the particle system.

delta : GameTime
time : GameTime
particleSystem : ParticleSystem
Returns: ParticleSystem * Output

ParticleSystem.toParticlesDescriptors time particleSystem

Full Usage: ParticleSystem.toParticlesDescriptors time particleSystem

Parameters:
Returns: ParticlesDescriptor list

Convert the emitted particles to ParticlesDescriptors.

time : GameTime
particleSystem : ParticleSystem
Returns: ParticlesDescriptor list

Type something to start searching.