Class TokenPF

Hierarchy

Token
- TokenPF

Index

Constructors

Accessors

actorVision disableLowLight isSquare sizeErrorMargin

Methods

_drawBar _getBarBoost _getBarUnderline _onApplyStatusEffect _onControl _onRelease getOccupiedCells

Constructors

constructor

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

Accessors

actorVision

get actorVision(): {
    lowLight: any;
    lowLightMultiplier: any;
    lowLightMultiplierBright: any;
}
Returns { lowLight: any; lowLightMultiplier: any; lowLightMultiplierBright: any }
- Defined in module/canvas/token.mjs:2

disableLowLight

get disableLowLight(): boolean
Returns boolean
- Defined in module/canvas/token.mjs:11

isSquare

get isSquare(): boolean
Is this token a square?

Returns boolean
- Defined in module/canvas/token.mjs:197

sizeErrorMargin

get sizeErrorMargin(): number
Returns error margin, in pixels, for measuring to and from token center.

Defined as larger of half the token's width and height.

Returns number
- Defined in module/canvas/token.mjs:162

Methods

`Protected`_drawBar

_drawBar(number: number, bar: Graphics, data: object): void
Protected
Draw a single resource bar, given provided data.
Parameters
- number: number
  The Bar number>
- bar: Graphics
  The Bar container.
- data: object
  Resource data for this bar.
Returns void
Overrides foundry.canvas.placeables.Token._drawBar
- Defined in module/canvas/token.mjs:100

`Protected`_getBarBoost

_getBarBoost(data: object): number | null
Protected
Parameters
- data: object
  Resource data for this bar
Returns number | null
The number to boost the bar by, if any.
- Defined in module/canvas/token.mjs:72

`Protected`_getBarUnderline

_getBarUnderline(data: object): number | null
Protected
Determines the length of the underline (bottom half-height bar overlay) on a token bar.
Parameters
- data: object
  Resource data for this bar
Returns number | null
The value of the bar underline, if any.
- Defined in module/canvas/token.mjs:86

_onApplyStatusEffect

_onApplyStatusEffect(statusId: any, active: any): void
Parameters
- statusId: any
- active: any
Returns void
Overrides foundry.canvas.placeables.Token._onApplyStatusEffect
- Defined in module/canvas/token.mjs:204

_onControl

_onControl(options: object): void
Parameters
- options: object
  Control options
Returns void
Overrides foundry.canvas.placeables.Token._onControl
- Defined in module/canvas/token.mjs:19

_onRelease

_onRelease(options: object): void
Parameters
- options: object
  Release options
Returns void
Overrides foundry.canvas.placeables.Token._onRelease
- Defined in module/canvas/token.mjs:29

getOccupiedCells

getOccupiedCells(options?: { center?: boolean }): Point[]
Return coordinates of cells the token occupies.

Result is modified result of TokenDocument#getOccupiedGridSpaceOffsets().
Parameters
- Optionaloptions: { center?: boolean } = {}
  Additional options
  - Optionalcenter?: boolean
    Return cell centers instead of origins
Returns Point[]
- Occupied cell coordinates.
- Defined in module/canvas/token.mjs:175