Class AbilityTemplate

SNAP_MODE

StaticSUPPORTED_TYPES

_onCancel

• _onCancel(event: Event): void

  Cancel the workflow (right-click)

  Parameters

  • event: Event

  Returns void

_onClickRight

• _onClickRight(event: any): void

  Parameters

  • event: any

  Returns void

_onConfirm

• _onConfirm(event: any): any

  Parameters

  • event: any

  Returns any

_onFinish

• _onFinish(event: Event): void

  Parameters

  • event: Event

  Returns void

_onMove

• _onMove(event: any): void

  Parameters

  • event: any

  Returns void

_onRotate

• _onRotate(event: Event): void

  Rotate the template by 3 degree increments (mouse-wheel)

  Parameters

  • event: Event

  Returns void

_previewTargets

• _previewTargets(): void

  Returns void

activatePreviewListeners

• activatePreviewListeners(initialLayer: CanvasLayer): Promise<object>

  Activate listeners for the template preview

  Parameters

  • initialLayer: CanvasLayer

    The initially active CanvasLayer to re-activate after the workflow is complete

  Returns Promise<object>

  Returns result object

drawPreview

• drawPreview(_event: Event): Promise<object>

  Creates a preview of the spell template

  Parameters

  • _event: Event

    The initiating click event

  Returns Promise<object>

  • Result

StaticfromData

• fromData(
      data: {
          color?: string;
          distance: number;
          flags?: object;
          texture?: string;
          type: "rect" | "circle" | "cone" | "ray";
      },
      options?: { action?: ItemAction },
  ): null | AbilityTemplate

  A factory method to create an AbilityTemplate instance using provided data

  Parameters

  • data: {
        color?: string;
        distance: number;
        flags?: object;
        texture?: string;
        type: "rect" | "circle" | "cone" | "ray";
    }

    Data used to create the template

    • Optionalcolor?: string

      Template color

    • distance: number

      The distance/size of the template

    • Optionalflags?: object

      Additional flags stored on the template

    • Optionaltexture?: string

      Path to template texture

    • type: "rect" | "circle" | "cone" | "ray"

      The type of template

  • Optionaloptions: { action?: ItemAction } = {}

  Returns null | AbilityTemplate

  • The template object, or null if the data does not produce a template