Class LevelUpForm

constructor

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

  Parameters

  • actor: Actor

  • item: Item = null

  • options: object = {}

  Returns LevelUpForm

Internal actor

config

mold

newLevel

Internal simulacra

Internal token

useBackgroundSkills

Static ICONS

id

• get id(): string

• Returns string

isLevelUp

• get isLevelUp(): boolean

• Returns boolean

isNewClass

• get isNewClass(): boolean

• Returns boolean

item

• get item(): ItemClassPF

• Returns ItemClassPF
• set item(cls): void

• Parameters

  • cls: ItemClassPF

  Returns void

title

• get title(): string

• Returns string

Static defaultOptions

• get defaultOptions(): InsertKeys<{
      baseApplication: undefined | null | string;
      classes: undefined | any[];
      closeOnSubmit: undefined | boolean;
      dragDrop: undefined | any[];
      editable: undefined | boolean;
      filters: undefined | any[];
      height: undefined | null | number | "auto";
      id: undefined | string;
      left: undefined | null | number;
      minimizable: undefined | boolean;
      popOut: undefined | boolean;
      resizable: undefined | boolean;
      scale: undefined | null | number;
      scrollY: undefined | any[];
      sheetConfig: undefined | boolean;
      submitOnChange: undefined | boolean;
      submitOnClose: undefined | boolean;
      tabs: undefined | any[];
      template: undefined | null | string;
      title: undefined | string;
      top: undefined | null | number;
      width: undefined | null | number;
  }, OmitByValue<{}, never>>

• Returns InsertKeys<{
      baseApplication: undefined | null | string;
      classes: undefined | any[];
      closeOnSubmit: undefined | boolean;
      dragDrop: undefined | any[];
      editable: undefined | boolean;
      filters: undefined | any[];
      height: undefined | null | number | "auto";
      id: undefined | string;
      left: undefined | null | number;
      minimizable: undefined | boolean;
      popOut: undefined | boolean;
      resizable: undefined | boolean;
      scale: undefined | null | number;
      scrollY: undefined | any[];
      sheetConfig: undefined | boolean;
      submitOnChange: undefined | boolean;
      submitOnClose: undefined | boolean;
      tabs: undefined | any[];
      template: undefined | null | string;
      title: undefined | string;
      top: undefined | null | number;
      width: undefined | null | number;
  }, OmitByValue<{}, never>>

_adjustAbilityScore

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

  Parameters

  • key: string

    Ability score key

  • op: string = null

    Operator clicked

  Returns 0 | 1 | -1

  • Direction of adjustment

_adjustAbilityScoreCost

• _adjustAbilityScoreCost(key, value): number

• Return cost of the adjustment.

  For homebrew support.

  Parameters

  • key: string

  • value: number

  Returns number

_adjustAbilityScoreValue

• _adjustAbilityScoreValue(key, value): 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
• Internal

  Get effective health roll formula.

  Parameters

  • type: string

  Returns string

_getHealthRoll

• _getHealthRoll(type, formula): Roll<any>
• Internal

  Generate roll instance for the health gain.

  Parameters

  • type: string

  • formula: string

  Returns Roll<any>

_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): void

• Parameters

  • event: any

  Returns void

_onCommit

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

  Commit level-up

  Parameters

  • event: Event

  Returns Promise<void>

_onSkip

• _onSkip(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_openItemSheet

• _openItemSheet(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_prepareAssociations

• _prepareAssociations(): void

• Returns void

_prepareHealthData

• _prepareHealthData(): void

• Returns void

_spoofHealthRoll

• _spoofHealthRoll(roll, value): 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: string;
          name: string;
          system: {
              description: {
                  value: string;
              };
              subType: string;
          };
          type: string;
      };
      update: boolean;
  } | {
      itemData: {
          _id: any;
          system.changes: any;
      };
      update: boolean;
  }

• Returns undefined | {
      itemData: {
          img: string;
          name: string;
          system: {
              description: {
                  value: string;
              };
              subType: string;
          };
          type: string;
      };
      update: boolean;
  } | {
      itemData: {
          _id: any;
          system.changes: any;
      };
      update: boolean;
  }

_updateObject

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

• Parameters

  • event: any

  • formData: any

  Returns Promise<unknown>

activateListeners

• activateListeners(html): void

• Parameters

  • html: JQuery<HTMLElement>

  Returns void

close

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

  Parameters

  • options: any

  Returns Promise<void>

createChatMessage

• createChatMessage(cardData): 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: string;
          gmroll: string;
          publicroll: string;
          selfroll: string;
      };
  }>

• 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: string;
          gmroll: string;
          publicroll: string;
          selfroll: string;
      };
  }>

getLevelData

• getLevelData(level): {
      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;
  }

  • bab: any

  • feats: number

  • fort: any

  • hd: number

  • hp: any

  • mythicTier: number

  • ref: any

  • skills: {
        bg: number;
        value: number;
    }

    • 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

Static addClassWizard

• addClassWizard(actor, itemData, options?): Promise<null | Item>

• Parameters

  • actor: Actor

    Owning actor

  • itemData: object

    Class item data

  • Optional options: {
        token: undefined | TokenDocument;
    } = {}

    Additional options

    • token: undefined | TokenDocument

      Associated token

  Returns Promise<null | Item>

Static increaseLevel

• increaseLevel(actor, item, options?): Promise<undefined | null | Item>

• Parameters

  • actor: Actor

    Owning actor

  • item: Item

    Class item

  • Optional options: {
        token: undefined | TokenDocument;
    } = {}

    Additional options

    • token: undefined | 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.