Options
All
  • Public
  • Public/Protected
  • All
Menu

A full-screen weather effect which renders rain drops and splashes.

Hierarchy

Index

Constructors

Methods

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

    Parameters

    • __namedParameters: Object

    Returns any[]

  • 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

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

    Returns void

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

    Returns void

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 = "WEATHER.Rain"

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

RAIN_CONFIG: EmitterConfigV3 = ...

Configuration for the particle emitter for rain

SPLASH_CONFIG: EmitterConfigV3 = ...

Configuration for the particle emitter for splashes