Class EnvironmentCanvasGroup

A container group which contains the primary canvas group and the effects canvas group.

Hierarchy

  • CanvasGroup<this>
    • EnvironmentCanvasGroup

Properties

colors layers weights groupName tearDownChildren

Accessors

darknessLevel hookName name

Methods

_draw draw initialize tearDown _createLayers _tearDown

Properties

colors

colors: {
    ambientBrightest: undefined;
    ambientDarkness: undefined;
    ambientDaylight: undefined;
    background: undefined;
    bright: undefined;
    darkness: undefined;
    dim: undefined;
    fogExplored: undefined;
    fogUnexplored: undefined;
    halfdark: undefined;
    sceneBackground: undefined;
} = ...

Colors exposed by the manager.

layers

layers: Record<string, CanvasLayer>

A mapping of CanvasLayer classes which belong to this group.

weights

weights: {
    bright: undefined;
    dark: undefined;
    dim: undefined;
    halfdark: undefined;
} = ...

Weights used by the manager to compute colors.

StaticgroupName

groupName: string = "environment"

StatictearDownChildren

tearDownChildren: boolean = false

Accessors

darknessLevel

  • get darknessLevel(): number

    Get the darkness level of this scene.

    Returns number

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 canvas group is the name of the constructor that is the immediate child of the defined base class.

    Returns string

Methods

_draw

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

    Parameters

    • options: any

    Returns Promise<void>

draw

  • draw(options?: object): Promise<EnvironmentCanvasGroup>

    Draw the canvas group and all its components.

    Parameters

    • Optionaloptions: object = {}

    Returns Promise<EnvironmentCanvasGroup>

    A Promise which resolves once the group is fully drawn

initialize

tearDown

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

    Remove and destroy all layers from the base canvas.

    Parameters

    • Optionaloptions: object = {}

    Returns Promise<EnvironmentCanvasGroup>

Protected_createLayers

  • _createLayers(): {}
    Protected

    Create CanvasLayer instances which belong to the canvas group.

    Returns {}

Protected_tearDown

  • _tearDown(options: object): Promise<void>
    Protected

    Remove and destroy all layers from the base canvas.

    Parameters

    • options: object

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods