Class AutumnLeavesWeatherEffect

A full-screen weather effect which renders gently falling autumn leaves.

Hierarchy (view full)

Properties

emitters label LEAF_CONFIG

Methods

getParticleEmitters createEmitter destroy play stop

Properties

emitters

emitters: Emitter[]

The array of emitters which are active for this particle effect

Static label

label: string = "WEATHER.AutumnLeaves"

Inherit Doc

Static LEAF_CONFIG

LEAF_CONFIG: EmitterConfigV3 = ...

Configuration for the particle emitter for falling leaves

Methods

getParticleEmitters

  • getParticleEmitters(): 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.

    Returns Emitter[]

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

destroy

play

  • play(): void

  • Begin animation for the configured emitters.

    Returns void

stop

  • stop(): void

  • Stop animation for the configured emitters.

    Returns void

Settings

Member Visibility

Theme

On This Page

emitterslabelLEAF_CONFIGgetParticleEmitterscreateEmitterdestroyplaystop