Class CanvasBackgroundAlterationEffects

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

Hierarchy (View Summary)

Properties

interactiveChildren lighting options vision visionPreferred

Accessors

hookName name instance layerOptions

Methods

_draw _tearDown clear draw tearDown

Properties

interactiveChildren

interactiveChildren: boolean = false

Whether this event target has any children that need UI events. This can be used optimize event propagation.

lighting

lighting: Container<DisplayObject>

A collection of effects which provide other background alterations.

options

options: { name: string } = ...

Options for this layer instance.

vision

vision: Container<DisplayObject>

A collection of effects which provide background vision alterations.

visionPreferred

visionPreferred: Container<DisplayObject>

A collection of effects which provide background preferred vision alterations.

Accessors

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

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"

Staticinstance

  • get instance(): CanvasLayer

    Return a reference to the active instance of this canvas layer

    Returns CanvasLayer

StaticlayerOptions

  • get layerOptions(): { name: string }

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

    Returns { name: string }

Methods

_draw

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

    Parameters

    • options: any

    Returns Promise<void>

_tearDown

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

    Parameters

    • options: any

    Returns Promise<void>

clear

  • clear(): void

    Clear background alteration effects vision and lighting containers

    Returns void

draw

  • draw(options?: object): 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

    • Optionaloptions: object = {}

      Options which configure how the layer is drawn

    Returns Promise<CanvasLayer>

tearDown

  • tearDown(options?: object): Promise<CanvasLayer>

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

    Parameters

    • Optionaloptions: object = {}

      Options which configure how the layer is deconstructed

    Returns Promise<CanvasLayer>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods