Class TokenDocumentPF

detectionModes

allowedMovement

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

  Allowed movement modes.

  Returns null | Set<string>

  Todo

  • Hook this up in token HUD movement action selection.

  Remarks

  • Returns null if there's no restrictions (e.g. no actor).

_preCreate

• _preCreate(data: object, context: object, user: User): Promise<void>
• Internal

  Parameters

  • data: object

    Creation data
  • context: object

    Context
  • user: User

    Triggering user

  Returns Promise<void>

_preCreateSetSize

• _preCreateSetSize(): void

• Handle actor size during token creation.

  TODO: This has overlapping functionality with Actor.getTokenDocument() that needs to be unified

  Returns void

_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

• _syncSenses(): void

• Synchronize senses from actor.

  Returns void

getBarAttribute

• getBarAttribute(
      barName: string,
      options?: { alternative?: string },
  ): null | object

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

prepareBaseData

• prepareBaseData(): void

• Prepare data related to this Document itself, before any embedded Documents or derived data is computed.

  Returns void

Static_getTrackedAttributesFromObject

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

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

  Parameters

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

  Returns any

Static_sortDetectionModes

• _sortDetectionModes(a: any, b: any): number

• Parameters

  • a: any
  • b: any

  Returns number