Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class CampaignSetup

    Campaign Setup

    Hierarchy

    • any
      • CampaignSetup
    Index

    Constructors

    constructor

    Properties

    config DEFAULT_OPTIONS PARTS

    Accessors

    promise

    Methods

    _getClassHealthConfig _onChangeForm _onClose _onSave _prepareMainContext _preparePartContext open

    Constructors

    • Returns CampaignSetup

    Properties

    config: {
        experience: string;
        health: {
            npc: string;
            pc: string;
            woundsAndVigor: boolean;
            woundThresholds: boolean;
        };
        houseRules: { weightlessCurrency: boolean };
        optional: {
            backgroundSkills: boolean;
            fractionalBaseBonuses: boolean;
            revisedActionEconomy: boolean;
        };
        options: { obfuscateDCs: boolean; obfuscateRolls: boolean };
        systemOfUnits: string;
    } = ...

    Configuration state tracker

    DEFAULT_OPTIONS: {
        actions: {
            dismiss: (
                this: CampaignSetup,
                event: PointerEvent,
                target: HTMLElement,
            ) => void;
        };
        classes: string[];
        form: {
            closeOnSubmit: boolean;
            handler: (
                this: CampaignSetup,
                event: PointerEvent,
                form: HTMLFormElement,
                formData: FormDataExtended,
            ) => Promise<void>;
        };
        id: string;
        position: { width: number };
        tag: string;
        window: { icon: string; title: string };
    } = ...
    PARTS: { footer: { template: string }; main: { template: string } } = ...

    Accessors

    • get promise(): Promise<any>

      Returns Promise<any>

    Methods

    _getClassHealthConfig

    • _getClassHealthConfig(
          type: any,
      ):
          | {
              "base.auto": boolean;
              "base.maximized"?: undefined;
              "base.rate"?: undefined;
              "npc.auto": boolean;
              "npc.maximized"?: undefined;
              "npc.rate"?: undefined;
              "racial.auto": boolean;
              "racial.maximized"?: undefined;
              "racial.rate"?: undefined;
          }
          | {
              "base.auto": boolean;
              "base.maximized"?: undefined;
              "base.rate": number;
              "npc.auto": boolean;
              "npc.maximized"?: undefined;
              "npc.rate": number;
              "racial.auto": boolean;
              "racial.maximized"?: undefined;
              "racial.rate": number;
          }
          | {
              "base.auto": boolean;
              "base.maximized": boolean;
              "base.rate": number;
              "npc.auto": boolean;
              "npc.maximized": boolean;
              "npc.rate": number;
              "racial.auto": boolean;
              "racial.maximized": boolean;
              "racial.rate": number;
          }
          | undefined

      Parameters

      • type: any

      Returns
          | {
              "base.auto": boolean;
              "base.maximized"?: undefined;
              "base.rate"?: undefined;
              "npc.auto": boolean;
              "npc.maximized"?: undefined;
              "npc.rate"?: undefined;
              "racial.auto": boolean;
              "racial.maximized"?: undefined;
              "racial.rate"?: undefined;
          }
          | {
              "base.auto": boolean;
              "base.maximized"?: undefined;
              "base.rate": number;
              "npc.auto": boolean;
              "npc.maximized"?: undefined;
              "npc.rate": number;
              "racial.auto": boolean;
              "racial.maximized"?: undefined;
              "racial.rate": number;
          }
          | {
              "base.auto": boolean;
              "base.maximized": boolean;
              "base.rate": number;
              "npc.auto": boolean;
              "npc.maximized": boolean;
              "npc.rate": number;
              "racial.auto": boolean;
              "racial.maximized": boolean;
              "racial.rate": number;
          }
          | undefined

    _onChangeForm

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

      Parameters

      • formConfig: any
      • event: any

      Returns void

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    _onSave

    • _onSave(formData: object): Promise<void>

      Function for modules to piggyback on if they need async handling.

      Parameters

      • formData: object

      Returns Promise<void>

    _prepareMainContext

    • _prepareMainContext(context: any, options: any): Promise<void>

      Parameters

      • context: any
      • options: any

      Returns Promise<void>

    _preparePartContext

    • _preparePartContext(partId: any, context: any, options: any): Promise<any>

      Parameters

      • partId: any
      • context: any
      • options: any

      Returns Promise<any>

    • Open the app and wait for it to close.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods