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

Hierarchy

Constructors

Properties

Accessors

Methods

_adjustActorPropertyBySpan _alterDropItemData _canDragStart _canShowRange _clearSearch _computeEncumbrance _convertCurrency _createPlaceholders _duplicateItem _editSkill _filterItems _focusTabByItem _hideShowElement _initializeFilterItemList _isItemSameSubGroup _itemActivationControl _itemPreparedToggle _mouseWheelAdd _moveTooltips _onArbitrarySkillCreate _onControlAlignment _onDragMiscStart _onDragSaveStart _onDragSkillStart _onDragStart _onDropCurrency _onDropItem _onDropItemCreate _onInputText _onItemCreate _onItemDelete _onItemEdit _onItemGive _onItemRoll _onItemSplit _onItemSummary _onLevelUp _onOpenCompendium _onOpenCompendiumEntry _onPointBuyCalculator _onResistanceSelector _onRest _onRollAbilityTest _onRollAttack _onRollBAB _onRollCL _onRollConcentration _onRollInitiative _onRollSavingThrow _onRollSkillCheck _onSensesSelector _onSkillCreate _onSkillDelete _onSkillEdit _onSpanTextInput _onSubmit _onToggleCondition _onToggleFilter _onToggleSkillLock _onTraitSelector _prepareHiddenElements _prepareItem _prepareItems _prepareSenseLabels _prepareSkills _prepareSkillsets _prepareSpellbook _prepareTraits _quickAction _quickCarryItem _quickChangeItemQuantity _quickEquipItem _quickIdentifyItem _render _renderInner _searchFilterChange _searchFilterCommit _searchFilterCompositioning _selectOnClick _setBuffLevel _setFeatUses _setItemActive _setMaxSpellUses _setSpellUses _sortNewItem _typeFilterCount _updateItems _updateObject activateListeners calculateSellItemValue calculateTotalItemValue getData openItemSummary setItemUpdate

Constructors

Properties

_filters: Set<any>

Track the set of item filters which are applied

_hiddenElems: {}

Track hidden elements of the sheet.

Type declaration

    effectiveSearch: {}

    Type declaration

      searchCompositioning: boolean

      Item search

      searchDelay: number
      searchDelayEvent: null | Timeout
      searchRefresh: boolean

      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;
            }[];
        }

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

      Methods

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

        Parameters

        • selector: string

          Selector string

        Returns boolean

      • Private

        Compute the level and percentage of encumbrance for an Actor.

        Parameters

        • actorData: object

          The data object for the Actor being rendered

        Returns object

        An object describing the character's encumbrance level

      • Opens a dialog to edit a skill.

        Parameters

        • skillId: string

          The id of the skill in question.

        • Optional subSkillId: string

          The id of the subskill, if appropriate.

        Returns Promise<void>

      • Private

        Determine whether an Item will be shown based on the current set of filters

        Parameters

        • items: object[]

          Raw data objects of items

        • filters: any

        Returns boolean

      • Parameters

        • event: DragEvent
        • type: "attack" | "bab" | "cmb" | "concentration" | "cl" | "defenses" | "initiative" | "abilityScore"
        • Optional subType: string

          Type specific subtype

        Returns void

      • Private

        Handle creating a new Owned Item for the actor using initial data defined in the HTML dataset

        Parameters

        • event: any

        Returns Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>

      • Private

        Handle rolling of an item from the Actor sheet, obtaining the Item instance and dispatching to it's roll method

        Parameters

        • event: any

        Returns undefined | Promise<void | ChatMessage>

      • Private

        Handle spawning the ActorResistanceSelector application which allows a number entry of multiple trait options

        Parameters

        • event: Event

          The click event which originated the selection

        Returns void

      • Parameters

        • event: any
        • __namedParameters: {
              preventClose: undefined | boolean;
              preventRender: undefined | boolean;
              updateData: undefined | null;
          } = {}
          • preventClose: undefined | boolean
          • preventRender: undefined | boolean
          • updateData: undefined | null

        Returns Promise<void>

      • Private

        Handle toggling of filters to display a different set of owned items

        Parameters

        • event: Event

          The click event which triggered the toggle

        Returns void

      • Private

        Handle spawning the ActorTraitSelector application which allows a checkbox of multiple trait options

        Parameters

        • event: Event

          The click event which originated the selection

        Returns void

      • Private

        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 {}

        • Activate event listeners using the prepared sheet HTML

          Parameters

          • html: JQuery<HTMLElement>

            The prepared HTML object ready to be rendered into the DOM

          Returns void

        • Parameters

          • __namedParameters: {
                inLowestDenomination: undefined | boolean;
                recursive: undefined | boolean;
            } = {}
            • inLowestDenomination: undefined | boolean
            • recursive: undefined | boolean

          Returns number

        • Parameters

          • __namedParameters: {
                inLowestDenomination: undefined | boolean;
                recursive: undefined | boolean;
            } = {}
            • inLowestDenomination: undefined | boolean
            • recursive: undefined | boolean

          Returns number

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

          Parameters

          • options: any

          Returns Promise<{
              actor: ActorPF;
              conditions: Conditions;
              config: config;
              cssClass: string;
              document: ActorPF;
              editable: boolean;
              effects: EmbeddedCollection<typeof ActiveEffect, ActorData>;
              hasHD: boolean;
              isCharacter: boolean;
              isGM: boolean;
              itemTypes: ItemTypesMap;
              limited: boolean;
              options: Options;
              owner: boolean;
              race: null | PropertiesToSource<ItemDataBaseProperties>;
              skillsLocked: boolean;
              sourceData: {};
              unchainedActions: unknown;
              units: {
                  distance: {
                      overland: string;
                      tactical: string;
                  };
                  weight: string;
              };
              usesAnySpellbook: boolean;
          }>

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

          Parameters

          • elem: JQuery<HTMLElement>

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

          • Optional instant: boolean = {}

            Whether to instantly show the expansion (true), or animate it (false)

          Returns Promise<void>

        Generated using TypeDoc