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

    Class OverlayCanvasGroup

    A container group which is not bound to the stage world transform.

    Index

    Properties

    layers groupName tearDownChildren

    Accessors

    hookName name

    Methods

    draw tearDown _createLayers _draw _tearDown

    Properties

    layers: Record<string, CanvasLayer>

    A mapping of CanvasLayer classes which belong to this group.

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

    Accessors

    • 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

    • Draw the canvas group and all its components.

      Parameters

      • Optionaloptions: object = {}

      Returns Promise<OverlayCanvasGroup>

      A Promise which resolves once the group is fully drawn

    • Remove and destroy all layers from the base canvas.

      Parameters

      • Optionaloptions: object = {}

      Returns Promise<OverlayCanvasGroup>

    Protected_createLayers

    • _createLayers(): {}
      Protected

      Create CanvasLayer instances which belong to the canvas group.

      Returns {}

    Protected_draw

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

      Draw the canvas group and all its component layers.

      Parameters

      • options: object

      Returns Promise<void>

    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