Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class TokenPF

    Hierarchy

    • Token
      • TokenPF
    Index

    Constructors

    constructor

    Accessors

    actorVision disableLowLight isSquare sizeErrorMargin

    Methods

    _drawBar _getBarBoost _getBarUnderline _isVisionSource _onControl _onRelease getOccupiedCells

    Constructors

    • Parameters

      • document: TokenDocument

        The Document instance which is represented by this object

      Returns TokenPF

    Accessors

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

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

    • 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 v13.340

      Returns boolean

      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

    • 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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods