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

    Class TokenDocumentPF

    Token Document extension

    Hierarchy

    • TokenDocument
      • TokenDocumentPF
    Index

    Constructors

    constructor

    Accessors

    allowedMovement

    Methods

    _preUpdate _syncSenses getBarAttribute prepareBaseData _getTrackedAttributesFromObject _getTrackedAttributesFromSchema _sortDetectionModes

    Constructors

    • Parameters

      • Optionaldata: CreateData

        Initial data from which to construct the TokenDocument

      • Optionalcontext: ConstructionContext

        Construction context options

      Returns TokenDocumentPF

    Accessors

    • get allowedMovement(): null | Set<string>
      Experimental

      Allowed movement modes.

      Returns null | Set<string>

      • Hook this up in token HUD movement action selection.
      • Returns null if there's no restrictions (e.g. no actor).

    Methods

    _preUpdate

    • _preUpdate(changed: object, context: object, user: User): Promise<void>
      Internal

      Parameters

      • changed: object

        Changed data

      • context: object

        Context

      • user: User

        Triggering user

      Returns Promise<void>

    _syncSenses

    • Hijack Token health bar rendering to include temporary and temp-max health in the bar display

      Parameters

      • barName: string

        Bar name

      • Optionaloptions: { alternative?: string } = {}

        Additional options

        • Optionalalternative?: string

          Alt bar path to use

      Returns null | object

      • Attribute to be displayed if any Synced with Foundry v13.348

    Static_getTrackedAttributesFromObject

    • _getTrackedAttributesFromObject(
          data: any,
          path?: any[],
      ): TrackedAttributesDescription

      Called by getTrackedAttributes() when not dealing with data models.

      Parameters

      • data: any
      • path: any[] = []

      Returns TrackedAttributesDescription

    Static_getTrackedAttributesFromSchema

    • _getTrackedAttributesFromSchema(
          schema: any,
          path?: any[],
      ): TrackedAttributesDescription

      Override to add in HP for vehicles.

      Parameters

      • schema: any
      • path: any[] = []

      Returns TrackedAttributesDescription

    Static_sortDetectionModes

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods