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

_mold

Internal_simulacra

levelUp

newLevel

StaticDEFAULT_OPTIONS

StaticICONS

Staticitem

StaticPARTS

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

title

• get title(): string

  A convenience reference to the title of the Application window.

  Returns string

_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

_configureRenderOptions

• _configureRenderOptions(options: any): any

  Parameters

  • options: any

  Returns any

_disableSheet

• _disableSheet(): void

  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

_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): Promise<RollPF>
  Internal

  Generate roll instance for the health gain.

  Parameters

  • type: string
  • formula: string

  Returns Promise<RollPF>

_getNextAbilityScoreLandmark

• _getNextAbilityScoreLandmark(): null | number
  Internal

  Get level at which next ability score is gained.

  Returns null | number

_initChoices

• _initChoices(): void

  Returns void

_initFCBChoices

• _initFCBChoices(): void

  Returns void

_initHealth

• _initHealth(): void

  Returns void

_initHPChoices

• _initHPChoices(): void

  Returns void

_initializeApplicationOptions

• _initializeApplicationOptions(options: any): any

  Parameters

  • options: any

  Returns any

_initSimulacra

• _initSimulacra(): void

  Create temporary clone actor to get correct values for the new level

  Returns void

_onChangeForm

• _onChangeForm(config: any, event: any): void

  Parameters

  • config: any
  • event: any

  Returns void

_onClose

• _onClose(options: any): void

  Parameters

  • options: any

  Returns void

_onRender

• _onRender(context: any, options: any): void

  Actions performed after any render of the Application.

  Parameters

  • context: any

    Prepared context data

  • options: any

    Provided render options

  Returns void

_prepareAssociations

• _prepareAssociations(): void

  Class association additions for the new level

  Returns void

_prepareContext

• _prepareContext(
      options: any,
  ): 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: {};
          labels: {};
          ready: boolean;
          visibility: null;
      },
  >

  Parameters

  • options: any

  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: {};
          labels: {};
          ready: boolean;
          visibility: null;
      },
  >

_prepareFCBPart

• _prepareFCBPart(context: any): any

  Parameters

  • context: any

  Returns any

_preparePartContext

• _preparePartContext(partId: any, context: any, options: any): any

  Prepare context that is specific to only a single rendered part.

  It is recommended to augment or mutate the shared context so that downstream methods like _onRender have visibility into the data that was used for rendering. It is acceptable to return a different context object rather than mutating the shared context at the expense of this transparency.

  Parameters

  • partId: any

    The part being rendered

  • context: any

    Shared context provided by _prepareContext

  • options: any

    Options which configure application rendering behavior

  Returns any

  Context data for a specific part

_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

_spoofHealthRoll

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

  Spoof roll, for maximized, auto and manual health.

  Parameters

  • roll: Roll<EmptyObject>
  • value: number

  Returns Roll<EmptyObject>

_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;
  }

  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<undefined | _Override<ChatMessagePF, {}>>

  Parameters

  • cardData: any

  Returns Promise<undefined | _Override<ChatMessagePF, {}>>

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>

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.