Class TokenPF

Hierarchy

  • Token
    • TokenPF

Constructors

constructor

Accessors

actorVision disableLowLight isSquare sizeErrorMargin

Methods

_drawBar _getBarBoost _getBarUnderline _isVisionSource _onControl _onRelease getOccupiedCells toggleEffect

Constructors

constructor

  • new TokenPF(document: TokenDocument): TokenPF

  • Parameters

    • document: TokenDocument

      The Document instance which is represented by this object

    Returns TokenPF

Accessors

actorVision

  • get actorVision(): {
        lowLight: any;
        lowLightMultiplier: any;
        lowLightMultiplierBright: any;
    }

  • Returns { lowLight: any; lowLightMultiplier: any; lowLightMultiplierBright: any }

disableLowLight

isSquare

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

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

Protected_getBarBoost

  • _getBarBoost(data: object): null | number
  • Protected

    Parameters

    • data: object

      Resource data for this bar

    Returns null | number

    The number to boost the bar by, if any.

Protected_getBarUnderline

  • _getBarUnderline(data: object): null | number
  • 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 null | number

    The value of the bar underline, if any.

_isVisionSource

  • _isVisionSource(): boolean

  • Override to support vision sharing and setting for minimum needed permission level.

    Synced with Foundry v12.331

    Returns boolean

    Since

    PF1 v10

_onControl

  • _onControl(options: object): void

  • Parameters

    • options: object

      Control options

    Returns void

_onRelease

  • _onRelease(options: object): void

  • Parameters

    • options: object

      Release options

    Returns void

getOccupiedCells

  • getOccupiedCells(options?: { center?: boolean }): Point[]

  • Return coordinates of cells the token occupies.

    Bug: Does not work with hex grid. Bug: Does not account for rotation.

    Parameters

    • Optionaloptions: { center?: boolean } = {}

      Additional options

      • Optionalcenter?: boolean

        Return cell centers instead of origins

    Returns Point[]

    • Occupied cell coordinates.

toggleEffect

  • toggleEffect(
        effect: string | object,
        options?: { active?: boolean; interaction?: boolean; overlay?: boolean },
    ): boolean

  • Synced with Foundry v12

    Parameters

    • effect: string | object

      Effect ID or data

    • options: { active?: boolean; interaction?: boolean; overlay?: boolean } = {}

      Additional options

      • Optionalactive?: boolean

        Force active state

      • Optionalinteraction?: boolean

        Nonstandard. Is this triggered by user interaction?

      • Optionaloverlay?: boolean

        Overlay effect

    Returns boolean

    • was it applied or removed

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods