Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmitterConfigV3

Full Emitter configuration for initializing an Emitter instance.

Hierarchy

  • EmitterConfigV3

Index

Properties

addAtBack?: boolean

If newly spawned particles should be added to the back of the parent container (to make them less conspicuous as they pop in). If omitted, particles will be added to the top of the container.

autoUpdate?: boolean

If the Emitter should hook into PixiJS's shared ticker. If this is false or emitted, you will be responsible for connecting it to update ticks.

behaviors: BehaviorEntry[]

The list of behaviors to apply to this emitter. See the behaviors namespace for a list of built in behaviors. Custom behaviors may be registered with Emitter.registerBehavior.

Easing to be applied to all interpolated or stepped values across the particle lifetime.

emit?: boolean

If the emitter should start out emitting particles. If omitted, it will be treated as true and will emit particles immediately.

emitterLifetime?: number

How long to run the Emitter before it stops spawning particles. If omitted, runs forever (or until told to stop manually).

frequency: number

How often to spawn particles. This is a value in seconds, so a value of 0.5 would be twice a second.

lifetime: RandNumber

Random number configuration for picking the lifetime for each particle..

maxParticles?: number

Maximum number of particles that can be alive at any given time for this emitter.

particlesPerWave?: number

How many particles to spawn at once, each time that it is determined that particles should be spawned. If omitted, only one particle will spawn at a time.

pos: { x: number; y: number }

Default position to spawn particles from inside the parent container.

Type declaration

  • x: number
  • y: number
spawnChance?: number

Defines a chance to not spawn particles. Values lower than 1 mean particles may not be spawned each time. If omitted, particles will always spawn.

Generated using TypeDoc