Class CanvasBackgroundAlterationEffects

A layer of background alteration effects which change the appearance of the primary group render texture.

Hierarchy (view full)

Properties

vision visionPreferred lighting options #drawing #drawn

Accessors

name hookName layerOptions instance

Methods

_draw _tearDown clear draw tearDown

Properties

vision

vision: Container

A collection of effects which provide background vision alterations.

visionPreferred

visionPreferred: Container

A collection of effects which provide background preferred vision alterations.

lighting

lighting: Container

A collection of effects which provide other background alterations.

options

options: {
    name: string;
} = ...

Options for this layer instance.

Type declaration

  • name: string

Private #drawing

#drawing: Promise<CanvasLayer> = ...

An internal reference to a Promise in-progress to draw the CanvasLayer.

Private #drawn

#drawn: boolean = false

Is the layer drawn?

Accessors

name

  • get name(): string

  • The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.

    Returns string

    Example

    canvas.lighting.name -> "LightingLayer"

hookName

  • get hookName(): string

  • The name used by hooks to construct their hook string. Note: You should override this getter if hookName should not return the class constructor name.

    Returns string

Static layerOptions

  • get layerOptions(): {
        name: string;
    }

  • Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.

    Returns {
        name: string;
    }

    • name: string

Static instance

  • get instance(): CanvasLayer

  • Return a reference to the active instance of this canvas layer

    Returns CanvasLayer

Methods

_draw

  • _draw(options): Promise<void>

  • Parameters

    • options: any

    Returns Promise<void>

_tearDown

  • _tearDown(options): Promise<void>

  • Parameters

    • options: any

    Returns Promise<void>

clear

  • clear(): void

  • Clear background alteration effects vision and lighting containers

    Returns void

draw

  • draw(options?): Promise<CanvasLayer>

  • Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.

    Parameters

    • Optional options: object = {}

      Options which configure how the layer is drawn

    Returns Promise<CanvasLayer>

tearDown

  • tearDown(options?): Promise<CanvasLayer>

  • Deconstruct data used in the current layer in preparation to re-draw the canvas

    Parameters

    • Optional options: object = {}

      Options which configure how the layer is deconstructed

    Returns Promise<CanvasLayer>

Settings

Member Visibility

Theme

On This Page

visionvisionPreferredlightingoptions#drawing#drawnnamehookNamelayerOptionsinstance_draw_tearDowncleardrawtearDown