Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class WeatherEffects

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

    Index

    Properties

    effects occlusionFilter occlusionMaskConfig suppression terrainMaskConfig weatherEffects

    Accessors

    elevation hookName sort sortLayer zIndex layerOptions

    Methods

    _draw _tearDown calculateBounds clearEffects initializeEffects configureOcclusionMask configureTerrainMask

    Properties

    effects: Map<string, any> = ...

    Array of weather effects linked to this weather container.

    occlusionFilter: WeatherOcclusionMaskFilter

    The inverse occlusion mask filter bound to this container.

    occlusionMaskConfig: WeatherOcclusionMaskConfiguration

    A default configuration of the terrain mask that is automatically applied to any shader-based weather effects. This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.

    suppression: Container<DisplayObject>

    The container in which suppression meshed are added.

    terrainMaskConfig: WeatherTerrainMaskConfiguration

    A default configuration of the terrain mask that is automatically applied to any shader-based weather effects. This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.

    weatherEffects: Container<DisplayObject>

    The container in which effects are added.

    Accessors

    • get elevation(): number

      The elevation of this object.

      Returns number

      Infinity
    • get hookName(): string

      Returns string

    • get sort(): number

      A key which resolves ties amongst objects at the same elevation within the same layer.

      Returns number

      0
    • get sortLayer(): number

      A key which resolves ties amongst objects at the same elevation of different layers.

      Returns number

      PrimaryCanvasGroup.SORT_LAYERS.WEATHER
    • get zIndex(): number

      A key which resolves ties amongst objects at the same elevation within the same layer and same sort.

      Returns number

      0
    • get layerOptions(): object

      Returns object

    Methods

    _draw

    • _draw(options: any): Promise<void>

      Parameters

      • options: any

      Returns Promise<void>

    _tearDown

    • _tearDown(options: any): Promise<any>

      Parameters

      • options: any

      Returns Promise<any>

    • Returns void

    • Clear the weather container.

      Returns void

    • Initialize the weather container from a weather config object.

      Parameters

      • OptionalweatherEffectsConfig: object

        Weather config object (or null/undefined to clear the container).

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods