Skip to main content

Interface: EmitterOptions

particles/options.EmitterOptions

Holds a set of options that control the basic functionality of an emitter.

Properties#

despawningRules#

despawningRules: ParticleDespawnRule[]

The rules used to determine when particles should be despawned.

remarks Note that if this array is reset, the particles will never be despawned by the emitter, and will only be cleared once the system is destroyed.

defaultvalue Despawns particles when their lifetime is over or when they leave the document bounds.

Defined in#

particles/options/emitterOptions.ts:44


duration#

duration: number

The duration of one emission cycle.

defaultvalue 5

Defined in#

particles/options/emitterOptions.ts:18


loops#

loops: number

The number of loops that should be performed. Negative numbers result in infinite loops.

defaultvalue 1

Defined in#

particles/options/emitterOptions.ts:23


maxParticles#

maxParticles: number

The maximum number of particles that may be active in the current emitter.

defaultvalue 300

Defined in#

particles/options/emitterOptions.ts:34


modules#

modules: ModuleFunction[]

The array of module functions used to modify particles while they are active.

remarks New modules can be created via the ModuleBuilder class. Alternatively, for full control, a function can be passed that takes a particle as a parameter, and modifies it.

Defined in#

particles/options/emitterOptions.ts:52


useGravity#

useGravity: boolean

Whether to apply gravity to the emitted particles.

defaultvalue true

Defined in#

particles/options/emitterOptions.ts:29