Class ParticleEffect`Interface`

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.

Hierarchy (view full)

any
- ParticleEffect
  - AutumnLeavesWeatherEffect

Index

Properties

Methods

createEmitter getParticleEmitters destroy play stop

Properties

emitters

emitters: Emitter[]

The array of emitters which are active for this particle effect

Methods

createEmitter

createEmitter(config): 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?): Emitter[]
Get the particle emitters which should be active for this particle effect. This base class creates a single emitter using the explicitly provided configuration. Subclasses can override this method for more advanced configurations.
Parameters
- Optional options: object = {}
  Options provided to the ParticleEffect constructor which can be used to customize configuration values for created emitters.
Returns Emitter[]

destroy

destroy(...args): void
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