Class LevelUpForm

constructor

• new LevelUpForm(actor: Actor, item?: Item, options?: object): LevelUpForm
• Internal

  Parameters

  • actor: Actor
  • item: Item = null
  • options: object = {}

  Returns LevelUpForm

Internalactor

config

mold

newLevel

Internalsimulacra

Internaltoken

useBackgroundSkills

StaticICONS

id

• get id(): string

• Return the CSS application ID which uniquely references this UI element

  Returns string

isLevelUp

• get isLevelUp(): boolean

• Returns boolean

isNewClass

• get isNewClass(): boolean

• Returns boolean

item

• get item(): ItemClassPF

• Returns ItemClassPF
• set item(cls: ItemClassPF): void

• Parameters

  • cls: ItemClassPF

  Returns void

title

• get title(): string

• An Application window should define its own title definition logic which may be dynamic depending on its data

  Returns string

StaticdefaultOptions

• get defaultOptions(): InsertKeys<{}, OmitByValue<{}, never>>

• Assign the default options which are supported by the entity edit sheet.

  Returns InsertKeys<{}, OmitByValue<{}, never>>

  The default options for this FormApplication class

  See

  Application.defaultOptions

  Default Value

  foundry.utils.mergeObject(super.defaultOptions, {
    classes: ["form"],
    closeOnSubmit: true,
    editable: true,
    sheetConfig: false,
    submitOnChange: false,
    submitOnClose: false
  });
  Copy

_adjustAbilityScore

• _adjustAbilityScore(key: string, op?: string): -1 | 0 | 1
• Internal

  Parameters

  • key: string

    Ability score key
  • op: string = null

    Operator clicked

  Returns -1 | 0 | 1

  • Direction of adjustment

_adjustAbilityScoreCost

• _adjustAbilityScoreCost(key: string, value: number): number

• Return cost of the adjustment.

  For homebrew support.

  Parameters

  • key: string
  • value: number

  Returns number

_adjustAbilityScoreValue

• _adjustAbilityScoreValue(key: string, value: number): number

• Determine actual ability score adjustment value.

  By default 1 for normal level-ups, 2 for mythic tiers.

  Uses pf1.config.levelAbilityScoreMult and pf1.config.tierAbilityScoreMult as multipliers.

  Parameters

  • key: string
  • value: number

  Returns number

_disableSheet

• _disableSheet(): void

• Returns void

_getDefaultHealthOption

• _getDefaultHealthOption(): string
• Internal

  Default health selection if auto health is not used.

  Returns string

_getDefaultHitPoints

• _getDefaultHitPoints(): number
• Internal

  Default hit points.

  Returns number

_getHealthFormula

• _getHealthFormula(type: string): string
• Internal

  Get effective health roll formula.

  Parameters

  • type: string

  Returns string

_getHealthRoll

• _getHealthRoll(type: string, formula: string): RollPF
• Internal

  Generate roll instance for the health gain.

  Parameters

  • type: string
  • formula: string

  Returns RollPF

_getNextAbilityScoreLandmark

• _getNextAbilityScoreLandmark(): null | number
• Internal

  Get level at which next ability score is gained.

  Returns null | number

_initChoices

• _initChoices(): void

• Returns void

_initData

• _initData(): void

• Returns void

_initFCBChoices

• _initFCBChoices(): void

• Returns void

_initHPChoices

• _initHPChoices(): void

• Returns void

_onClickAbilityScoreOperator

• _onClickAbilityScoreOperator(event: any): void

• Parameters

  • event: any

  Returns void

_onCommit

• _onCommit(event: Event): Promise<void>
• Internal

  Commit level-up

  Parameters

  • event: Event

  Returns Promise<void>

_onSkip

• _onSkip(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_openItemSheet

• _openItemSheet(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_prepareAssociations

• _prepareAssociations(): void

• Returns void

_prepareHealthData

• _prepareHealthData(): void

• Returns void

_spoofHealthRoll

• _spoofHealthRoll(roll: Roll<any>, value: number): Roll<any>
• Internal

  Spoof roll, for maximized, auto and manual health.

  Parameters

  • roll: Roll<any>
  • value: number

  Returns Roll<any>

_updateAbilityScore

• _updateAbilityScore(): | undefined
  | {
      itemData: {
          img: "systems/pf1/icons/skills/affliction_10.jpg";
          name: "PF1.LevelUp.AbilityScore.Item.Name";
          system: {
              description: { value: "PF1.LevelUp.AbilityScore.Item.Desc" };
              subType: "misc";
          };
          type: "feat";
      };
      update: boolean;
  }
  | { itemData: { _id: any; "system.changes": any }; update: boolean }

• Returns
      | undefined
      | {
          itemData: {
              img: "systems/pf1/icons/skills/affliction_10.jpg";
              name: "PF1.LevelUp.AbilityScore.Item.Name";
              system: {
                  description: { value: "PF1.LevelUp.AbilityScore.Item.Desc" };
                  subType: "misc";
              };
              type: "feat";
          };
          update: boolean;
      }
      | { itemData: { _id: any; "system.changes": any }; update: boolean }

_updateObject

• _updateObject(event: any, formData: any): Promise<unknown>

• This method is called upon form submission after form data is validated

  Parameters

  • event: any

    The initial triggering submission event
  • formData: any

    The object of validated form data with which to update the object

  Returns Promise<unknown>

  A Promise which resolves once the update operation has completed

activateListeners

• activateListeners(html: JQuery<HTMLElement>): void

• Parameters

  • html: JQuery<HTMLElement>

  Returns void

close

• close(options: any): Promise<void>
• Internal

  Parameters

  • options: any

  Returns Promise<void>

createChatMessage

• createChatMessage(
      cardData: any,
  ): Promise<undefined | StoredDocument<ChatMessagePF>>

• Parameters

  • cardData: any

  Returns Promise<undefined | StoredDocument<ChatMessagePF>>

getData

• getData(): Promise<
      {
          abilityScore: { new: number; used: number; get available(): number };
          actor: ActorPF;
          config: config;
          document: ItemClassPF;
          fcb: { available: boolean; choice: string; unavailable: boolean };
          feats: number;
          health: { manual: null; type: null; value: number };
          icons: any;
          item: PropertiesToSource<ItemDataBaseProperties>;
          labels: { fcb: { alt: string; hp: string; none: string; skill: string } };
          useBackgroundSkills: unknown;
          visibility: null;
          visibilityOptions: {
              blindroll: "PF1.Chat.Visibility.Blind";
              gmroll: "PF1.Chat.Visibility.Private";
              publicroll: "PF1.Chat.Visibility.Public";
              selfroll: "PF1.Chat.Visibility.Self";
          };
      },
  >

• Returns Promise<
      {
          abilityScore: { new: number; used: number; get available(): number };
          actor: ActorPF;
          config: config;
          document: ItemClassPF;
          fcb: { available: boolean; choice: string; unavailable: boolean };
          feats: number;
          health: { manual: null; type: null; value: number };
          icons: any;
          item: PropertiesToSource<ItemDataBaseProperties>;
          labels: { fcb: { alt: string; hp: string; none: string; skill: string } };
          useBackgroundSkills: unknown;
          visibility: null;
          visibilityOptions: {
              blindroll: "PF1.Chat.Visibility.Blind";
              gmroll: "PF1.Chat.Visibility.Private";
              publicroll: "PF1.Chat.Visibility.Public";
              selfroll: "PF1.Chat.Visibility.Self";
          };
      },
  >

getLevelData

• getLevelData(
      level: any,
  ): {
      bab: any;
      feats: number;
      fort: any;
      hd: number;
      hp: any;
      mythicTier: number;
      ref: any;
      skills: { bg: number; value: number };
      totalHD: any;
      totalMythicTier: any;
      will: any;
  }

• Parameters

  • level: any

  Returns {
      bab: any;
      feats: number;
      fort: any;
      hd: number;
      hp: any;
      mythicTier: number;
      ref: any;
      skills: { bg: number; value: number };
      totalHD: any;
      totalMythicTier: any;
      will: any;
  }

isFavouredClass

• isFavouredClass(): boolean

• Returns boolean

  Whether this form's associated class is a favoured class.

  Todo

  Add better logic for determining this <26-01-22, Furyspark>

isReady

• isReady(): boolean

• Determine if this level-up is finalized.

  Returns boolean

StaticaddClassWizard

• addClassWizard(
      actor: Actor,
      itemData: object,
      options?: { token?: TokenDocument },
  ): Promise<null | Item>

• Parameters

  • actor: Actor

    Owning actor
  • itemData: object

    Class item data
  • Optionaloptions: { token?: TokenDocument } = {}

    Additional options

    • Optionaltoken?: TokenDocument

      Associated token

  Returns Promise<null | Item>

StaticincreaseLevel

• increaseLevel(
      actor: Actor,
      item: Item,
      options?: { token?: TokenDocument },
  ): Promise<undefined | null | Item>

• Parameters

  • actor: Actor

    Owning actor
  • item: Item

    Class item
  • Optionaloptions: { token?: TokenDocument } = {}

    Additional options

    • Optionaltoken?: TokenDocument

      Associated token

  Returns Promise<undefined | null | Item>

  • Updated class item if updated or null if process was cancelled. Undefined if this re-opened existing dialog.