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

    Extend the basic ActorSheet class to do all the PF things! This sheet is an Abstract layer which is not used.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _activeEdits: Record<string, string> = {}
    _filters: Record<string, Record<string, Set<string>>> = ...

    Track the set of item filters which are applied

    _skillsLocked: any
    _warnedAppV1: boolean = true
    ACTIONS: {
        __proto__: null;
        adjustQuantity: Object;
        browse: Object;
        carryItem: Object;
        convertCurrency: Object;
        createItem: Object;
        createSkill: Object;
        createSubSkill: Object;
        defensesCard: Object;
        deleteItem: Object;
        deleteSkill: Object;
        displayItemCard: Object;
        dupeItem: Object;
        editCondition: Object;
        editItem: Object;
        editResistances: Object;
        editSenses: Object;
        editSkill: Object;
        editTraits: Object;
        equipItem: Object;
        giveItem: Object;
        journal: Object;
        levelUp: Object;
        pointBuy: Object;
        rest: Object;
        rollAbility: Object;
        rollBAB: Object;
        rollCasterLevel: Object;
        rollConcentration: Object;
        rollInit: Object;
        rollSave: Object;
        rollSkill: Object;
        selectAlignment: Object;
        spellConfig: Object;
        splitItem: Object;
        toggleCondition: Object;
        toggleFilter: Object;
        toggleIdentified: Object;
        toggleItemSummary: Object;
        toggleLock: Object;
        togglePrepared: Object;
        useGenericAttack: Object;
        useItem: Object;
    } = ...

    Temporary action mapping until AppV2 conversion.

    BASE_APPLICATION: typeof ActorSheetPF = ...

    Remove with AppV2 conversion

    EDIT_TRACKING: string[] = ...

    Which fields to track edits for

    WHEEL_UPDATE_SCOPES: string[] = ...

    Accessors

    • get defaultOptions(): {
          classes: string[];
          dragDrop: { dragSelector: string }[];
          scrollY: string[];
          tabs: {
              contentSelector: string;
              group: string;
              initial: string;
              navSelector: string;
          }[];
      }

      Returns {
          classes: string[];
          dragDrop: { dragSelector: string }[];
          scrollY: string[];
          tabs: {
              contentSelector: string;
              group: string;
              initial: string;
              navSelector: string;
          }[];
      }

    Methods

    • Internal

      Filters item by sheet section config.

      Parameters

      • item: Item<"base" | ModuleSubType>

        Item to filter

      • section: object

        Section to filter by

      Returns boolean

    • Allow drag start always. Foundry blocks this if sheet is not editable, which blocks copying items.

      Parameters

      • selector: string

        Selector string

      Returns boolean

    • Protected

      Determine if the item can have its range shown on this sheet.

      Parameters

      • item: Item<"base" | ModuleSubType>

      Returns boolean

    • Internal

      Submit input value

      Parameters

      • event: Event
      • target: HTMLElement
      • OptionalnewValue: any

      Returns Promise<void>

    • Opens a dialog to edit a skill.

      Parameters

      • skillId: string

        The id of the skill in question.

      • OptionalsubSkillId: string

        The id of the subskill, if appropriate.

      Returns Promise<void>

    • Internal

      Filter inventory section

      Called in ()

      Parameters

      • category: object

        Category data

      • section: object

        Section data

      • filters: Set<string>

        Active filters

      Returns void

    • Protected

      Parameters

      • fullId: string

        Target ID

      • context: object

        Context object to store data into

      Returns Promise<void>

      • If provided ID is invalid.
    • Nameless Change Event

      Handler for any change event that did not target an element with name.

      Parameters

      • event: Event
      • target: HTMLElement

      Returns boolean

      • True if the change was handled, false otherwise.
    • Protected

      Non-action button clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Click target

      Returns boolean

      • True if the click was handled, false otherwise
    • Protected

      Handle action button clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Action element

      Returns boolean

      • true if handler was found, false otherwise.
    • Protected

      Non-action context clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Click target

      Returns boolean

      • True if this click was handled, false otherwise
    • Protected

      Handle right-click actions

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns boolean

      • True if click was handled, false otherwise.
    • Parameters

      • event: DragEvent

        Drag start event

      • type:
            | "initiative"
            | "attack"
            | "cl"
            | "bab"
            | "cmb"
            | "concentration"
            | "abilityScore"
            | "defenses"
      • OptionalsubType: string

        Type specific subtype

      • Optionaldataset: object

        Whole dataset

      Returns void

    • Parameters

      • event: any
      • data: any

      Returns Promise<undefined | ItemPF[] | _Override<Item<"base" | ModuleSubType>, {}>[]>

    • Parameters

      • event: Event
      • itemData: object

      Returns Promise<undefined | _Override<Item<"base" | ModuleSubType>, {}>[]>

    • Protected

      Finalize Wheel Update

      Parameters

      • target: HTMLElement

      Returns undefined | object

      • object with wheel element info, undefined if this is not valid element
    • Protected

      Handle input

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement
      • callback: Function

        Submission handler

      Returns any

    • Experimental

      Weight Tooltips

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

      Convert into extended tooltip?

    • Protected

      Alter span text value before committing.

      Parameters

      • name: string

        Update path

      • value: number

        Numeric value

      • str: string

        Original string from input

      Returns any

    • Protected

      Parameters

      • item: object

        Item render data

      • section: object

        Item section

      • context: object

        Render context

      Returns void

    • Internal

      Insert a spell into the spellbook object when rendering the character sheet

      Parameters

      • data: object

        The Actor data being prepared

      • spells: any[]

        The spell data being prepared

      • bookKey: string

        The key of the spellbook being prepared

      Returns object

      • Spellbook data
    • Protected

      Toggle inline display of an item's summary/description by expanding or hiding info div

      Parameters

      • elem: HTMLElement

        The element to open. Likely will have the item class in CSS.

      • Optionalanimation: boolean = {}

        Whether to animate expansion and collapse or not.

      Returns Promise<void>

    • Activate event listeners using the prepared sheet HTML

      Parameters

      • jq: JQuery<HTMLElement>

        The prepared HTML object ready to be rendered into the DOM

      Returns void

    • Parameters

      • __namedParameters: { inLowestDenomination?: boolean; recursive?: boolean } = {}

      Returns number

    • Parameters

      • __namedParameters: { inLowestDenomination?: boolean; recursive?: boolean } = {}

      Returns number

    • Add some extra data when rendering the sheet to reduce the amount of logic required within the template.

      Returns Promise<
          {
              actor: ActorPF;
              choices: {};
              config: ./config.mjs;
              cssClass: string;
              document: ActorPF;
              editable: boolean;
              effects: EmbeddedCollection<ActiveEffect<"base" | ModuleSubType>, ActorPF>;
              hasHD: boolean;
              isCharacter: boolean;
              isGM: boolean;
              itemTypes: ItemTypesMap;
              limited: boolean;
              options: Options;
              owner: boolean;
              race: null | {};
              skillsLocked: boolean;
              sourceData: {};
              unchainedActions: SettingInitializedType<"core", KeyFor<"core">>;
              units: {
                  distance: {
                      overland: "PF1.Distance.miShort" | "PF1.Distance.kmShort";
                      tactical: "PF1.Distance.ftShort" | "PF1.Distance.mShort";
                  };
                  weight: string;
              };
              usesAnySpellbook: boolean;
          },
      >