Class LevelUpForm

constructor

• new LevelUpForm(
      options: {
          actor: Actor<"base" | ModuleSubType>;
          item: Item<"base" | ModuleSubType>;
          token: Token;
      },
  ): LevelUpForm
  Internal

  Parameters

  • options: {
        actor: Actor<"base" | ModuleSubType>;
        item: Item<"base" | ModuleSubType>;
        token: Token;
    }

  Returns LevelUpForm

Internal_mold

Internal_simulacra

InternallevelUp

InternalnewLevel

StaticICONS

Staticitem

actor

• get actor(): ActorPF

  Returns ActorPF

isLevelUp

• get isLevelUp(): boolean

  Returns boolean

isNewClass

• get isNewClass(): boolean

  Returns boolean

isReady

• get isReady(): boolean

  Determine if this level-up is finalized.

  Returns boolean

item

• get item(): ItemClassPF

  Returns ItemClassPF

• set item(cls: ItemClassPF): void

  Parameters

  • cls: ItemClassPF

  Returns void

promise

• get promise(): Promise<null | Item<"base" | ModuleSubType>>

  Promise for when the wizard finishes.

  Resolves either into the added or updated class item, or null if cancelled.

  Returns Promise<null | Item<"base" | ModuleSubType>>

_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

_adjustPartConfig

• _adjustPartConfig(partId: string): void

  Perform modifications for specific part

  Parameters

  • partId: string

  Returns void

_disableSheet

• _disableSheet(): void

  Disable all buttons and inputs and set progress indicator

  Returns void

_generateLevelDeltas

• _generateLevelDeltas(): void
  Internal

  Initialize and diff level values

  Calculates many effects of the different levels.

  • Skills
  • Ability score effects
  • HD changes etc.

  Returns void

_getDefaultHealthOption

• _getDefaultHealthOption(): string
  Internal

  Default health selection if auto health is not used.

  Returns string

_getNextAbilityScoreLandmark

• _getNextAbilityScoreLandmark(): null | number
  Internal

  Get level at which next ability score is gained.

  Returns null | number

_prepareAssociations

• _prepareAssociations(): void

  Class association additions for the new level

  Returns void

_prepareFCBPart

• _prepareFCBPart(context: any): any

  Parameters

  • context: any

  Returns any

_regenerateDeltas

• _regenerateDeltas(): void
  Internal

  Returns void

_setHealth

• _setHealth(): void
  Internal

  Set current health value and any bonuses to it

  Returns void

_setSkills

• _setSkills(): void
  Internal

  Set skills ranks.

  Returns void

_updateAbilityScore

• _updateAbilityScore(): | undefined
  | {
      itemData: { _id: null
      | string; "system.changes": any };
      update: boolean;
  }
  | {
      itemData: {
          img: "systems/pf1/icons/skills/affliction_10.jpg";
          name: "Added Ability Scores";
          system: {
              description: {
                  value: "<p>This feature is used for tracking your ability score changes from gaining hit die.</p>";
              };
              subType: "misc";
          };
          type: "feat";
      };
      update: boolean;
  }
  Internal

  Returns
      | undefined
      | {
          itemData: { _id: null
          | string; "system.changes": any };
          update: boolean;
      }
      | {
          itemData: {
              img: "systems/pf1/icons/skills/affliction_10.jpg";
              name: "Added Ability Scores";
              system: {
                  description: {
                      value: "<p>This feature is used for tracking your ability score changes from gaining hit die.</p>";
                  };
                  subType: "misc";
              };
              type: "feat";
          };
          update: boolean;
      }

createChatMessage

• createChatMessage(cardData: any): Promise<any>
  Internal

  Parameters

  • cardData: any

  Returns Promise<any>

getLevelData

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

  Parameters

  • level: any

  Returns {
      bab: any;
      feats: number;
      fort: any;
      hd: any;
      hp: any;
      mythicTier: any;
      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>

StaticaddClass

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

  Add class to actor

  Parameters

  • actor: Actor<"base" | ModuleSubType>

    Owning actor

  • itemData: object

    Class item data

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

    Additional options

    • Optionaltoken?: TokenDocument

      Associated token

  Returns Promise<null | Item<"base" | ModuleSubType>>

StaticincreaseLevel

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

  Increase level of a class

  Parameters

  • actor: Actor<"base" | ModuleSubType>

    Owning actor

  • item: Item<"base" | ModuleSubType>

    Class item

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

    Additional options

    • Optionaltoken?: TokenDocument

      Associated token

  Returns Promise<undefined | null | Item<"base" | ModuleSubType>>

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