Skip to main content

Emitters

Emitters play all Sound objects inside of them and emit all ParticleEmitter objects inside of them when touched.

Use Cases

Emitters can be used for cinematic effects and gameplay cues. They can be limited by the Uses configuration as to not emit more than the specified number of times.

Sound and ParticleEmitter objects have an optional EmitDelay attribute that specifies how long the Emitter should wait for before emitting those objects. ParticleEmitters also have an optional EmitCount attribute that specifies how many particles to emit.

Configuration

NameDefault ValueDescription
GlobalSoundtrueWhether Sound instances should play globally or spatially from the Emitter.
Uses0How many times the Emitter can be used. Every time the emitter is used, this value is decremented. If set to 0, the Emitter will have infinite uses.
Cooldown1Time in seconds to wait before the Emitter can activate again.