Interface: ParticleEmitterConfig<Effects>

Configuration for a particle emitter.

Type parameters

Name Type
Effects extends string = string

Properties

effects

effects: Record<Effects, ParticleEffectConfig>

Particle effect configurations.


position

Optional position: Point

Optional emitter position, defaults to 0, 0 if not provided. If the entity that the emitter belongs to has a Position aspect the emitter position will be automatically updated each frame to match it.

If the emitter is going to be used instantly the Position aspect should be provided in the position parameter to emit from the correct position as the update has not had a chance to run yet.


system

system: ParticleSystem

The particle system that the emitter belongs to.