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

    Class TokenDocumentPF

    Token Document extension

    Hierarchy

    • TokenDocument
      • TokenDocumentPF
    Index

    Constructors

    • Parameters

      • Optionaldata: CreateData

        Initial data from which to construct the TokenDocument

      • Optionalcontext: ConstructionContext

        Construction context options

      Returns TokenDocumentPF

    Properties

    _initializedSenses: undefined | boolean
    MOVEMENT_DISABLING_CONDITIONS: Set<string> = ...
    • Record this info in conditions registry.

    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

    • Returns string

      • Query actor itself for what it should do.
    • Parameters

      • options: any

      Returns void

    • Parameters

      • movement: object

        Movement info

      • context: object

        Update operation

      • user: User

        Triggering user

      Returns void

    • HACK: Override to prevent Foundry preparing detection modes ahead of time to actor being ready.

      Foundry calls this in prepareBaseData() before the synthetic actor is ready, system must thus call it again after the synthetic actor and syncing of senses has been completed.

      Returns void

    • Internal

      Parameters

      • changed: object

        Changed data

      • context: object

        Context

      • user: User

        Triggering user

      Returns Promise<void>

    • Synchronize senses from actor.

      Returns void

    • 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
    • Returns void

    • Returns void

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

      Parameters

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

      Returns TrackedAttributesDescription

    • Override to add in HP for vehicles.

      Parameters

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

      Returns TrackedAttributesDescription

    • Parameters

      • a: any
      • b: any

      Returns number