EffectsLayer

EffectsLayer

A CanvasLayer for displaying visual effects like weather, transitions, flashes, or more

Constructor

new EffectsLayer()

Members

(static) layerOptions

emitters :Array.<Object>

Track any active emitters within this Scene

Type:

weather :PIXI.Container

The weather overlay container

Type:
  • PIXI.Container

weatherEffect :SpecialEffect

The currently active weather effect

Type:

weatherOcclusionFilter :AbstractBaseMaskFilter

An occlusion filter that prevents weather from being displayed in certain regions

Type:

Methods

(async) draw()

drawWeather() → {PIXI.Container|null}

Draw the weather container.

Returns:

The weather container, or null if no effect is present

Type
PIXI.Container | null

(async) tearDown()