Options
All
  • Public
  • Public/Protected
  • All
Menu

An interface for defining particle-based weather effects

param parent

The parent container within which the effect is rendered

param [options]

Options passed to the getParticleEmitters method which can be used to customize values of the emitter configuration.

interface

Hierarchy

Index

Constructors

Properties

The parent particle container within which the effect is rendered

emitters: Emitter[]

The array of emitters which are active for this particle effect

label: string = "Particle Effect"

A human-readable label for the weather effect. This can be a localization string.

Methods

  • createEmitter(config: EmitterConfigV3): Emitter
  • Create an emitter instance which automatically updates using the shared PIXI.Ticker

    Parameters

    • config: EmitterConfigV3

      The emitter configuration

    Returns Emitter

    The created Emitter instance

  • getParticleEmitters(options?: any): Emitter[]
  • Get the particle emitters which should be active for this particle effect.

    Parameters

    • options: any = {}

    Returns Emitter[]

  • destroy(): void
  • Destroy all emitters related to this ParticleEffect

    Returns void

  • play(): void
  • Begin animation for the configured emitters.

    Returns void

  • stop(): void
  • Stop animation for the configured emitters.

    Returns void