Class AbilityTemplate

A helper class for building MeasuredTemplates for PF1 spells and abilities

Hierarchy

MeasuredTemplatePF
- AbilityTemplate

Index

Constructors

Properties

active document hitArea

Methods

activatePreviewListeners drawPreview refresh fromData

Constructors

constructor

new AbilityTemplate(document): AbilityTemplate
Parameters
- document: MeasuredTemplateDocument
  
  The Document instance which is represented by this object
Returns AbilityTemplate
Inherited from MeasuredTemplatePF.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/pixi/placeable.d.ts:18

Properties

active

active: undefined | boolean

document

document: any

hitArea

hitArea: IHitArea

Methods

activatePreviewListeners

activatePreviewListeners(initialLayer): Promise<boolean>
Activate listeners for the template preview
Parameters
- initialLayer: CanvasLayer<CanvasLayerOptions>
  
  The initially active CanvasLayer to re-activate after the workflow is complete
Returns Promise<boolean>
Returns true if placed, or false if cancelled
- Defined in module/canvas/ability-template.mjs:87

drawPreview

drawPreview(event): Promise<boolean>
Creates a preview of the spell template
Parameters
- event: Event
  
  The initiating click event
Returns Promise<boolean>
- Defined in module/canvas/ability-template.mjs:70

refresh

refresh(): undefined | AbilityTemplate
Returns undefined | AbilityTemplate
Overrides MeasuredTemplatePF.refresh
- Defined in module/canvas/ability-template.mjs:195

`Static` fromData

fromData(options): null | AbilityTemplate
A factory method to create an AbilityTemplate instance using provided data
Parameters
- options: any
Returns null | AbilityTemplate
The template object, or null if the data does not produce a template
- Defined in module/canvas/ability-template.mjs:17

Generated using TypeDoc