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

    Class EnvironmentCanvasGroup

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

    Index

    Properties

    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: Record<string, CanvasLayer>

    A mapping of CanvasLayer classes which belong to this group.

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

    Weights used by the manager to compute colors.

    groupName: string = "environment"
    tearDownChildren: boolean = false

    Accessors

    • get darknessLevel(): number

      Get the darkness level of this scene.

      Returns number

    • 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

    • 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

    • Parameters

      • options: any

      Returns Promise<void>

    • Draw the canvas group and all its components.

      Parameters

      • Optionaloptions: object = {}

      Returns Promise<EnvironmentCanvasGroup>

      A Promise which resolves once the group is fully drawn

    • Remove and destroy all layers from the base canvas.

      Parameters

      • Optionaloptions: object = {}

      Returns Promise<EnvironmentCanvasGroup>

    • Protected

      Create CanvasLayer instances which belong to the canvas group.

      Returns {}

    • Protected

      Remove and destroy all layers from the base canvas.

      Parameters

      • options: object

      Returns Promise<void>