Class MeasuredTemplatePF

Hierarchy (View Summary)

MeasuredTemplate
- MeasuredTemplatePF
  - AbilityTemplate

Index

Constructors

Accessors

Methods

_getGridHighlightPositions getHighlightLayer getTokensWithin

Constructors

constructor

new MeasuredTemplatePF(document: MeasuredTemplateDocument): MeasuredTemplatePF
Parameters
- document: MeasuredTemplateDocument
  The Document instance which is represented by this object
Returns MeasuredTemplatePF
Inherited from foundry.canvas.placeables.MeasuredTemplate.constructor
- Defined in node_modules/fvtt-types/src/foundry/client/canvas/placeables/placeable-object.d.mts:37

Accessors

origin

get origin(): void | Item<"base" | ModuleSubType> | ItemAction
Return origin item if any.

Returns void | Item<"base" | ModuleSubType> | ItemAction
- Defined in module/canvas/measure.mjs:353

Methods

`Protected`_getGridHighlightPositions

_getGridHighlightPositions(): Point[]
Protected
Get highlighted square coordinates.

Supports only circle, cone and ray templates.

Returns Point[]
- Array of grid coordinates
Overrides foundry.canvas.placeables.MeasuredTemplate._getGridHighlightPositions
- Defined in module/canvas/measure.mjs:157

getHighlightLayer

getHighlightLayer(): undefined | GridHighlight
Returns undefined | GridHighlight
- Defined in module/canvas/measure.mjs:344

getTokensWithin

getTokensWithin(): Token[]
Determine tokens residing within the template bounds, based on either grid highlight logic or token center.

Returns Token[]
Tokens sufficiently within the template.
- Defined in module/canvas/measure.mjs:230