Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticleEffect

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

Methods

Constructors

constructor

  • Parameters

    • options: {} = {}

      Returns ParticleEffect

    Properties

    emitters

    emitters: Emitter[]

    The array of emitters which are active for this particle effect

    Methods

    createEmitter

    • 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

    • getParticleEmitters(options?: any): Emitter[]

    • Get the particle emitters which should be active for this particle effect.

      Parameters

      • options: any = {}

      Returns Emitter[]

    destroy

    • destroy(...args: any[]): void
    • override

      Parameters

      • Rest ...args: any[]

      Returns void

    play

    • play(): void

    • Begin animation for the configured emitters.

      Returns void

    stop

    • stop(): void

    • Stop animation for the configured emitters.

      Returns void