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

    Class ExperienceConfigModel

    Hierarchy

    • DataModel
      • ExperienceConfigModel
    Index

    Constructors

    constructor

    Accessors

    progressionOptions

    Methods

    defineSchema migrateData

    Constructors

    • Parameters

      • ...args: ConstructorArgs<any, null, any>

      Returns ExperienceConfigModel

    Accessors

    • get progressionOptions(): {
          custom: string;
          fast: string;
          medium: string;
          slow: string;
      }

      Returns { custom: string; fast: string; medium: string; slow: string }

    Methods

    • Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

      Returns {
          custom: SchemaField<
              { formula: FormulaField },
              DefaultOptions,
              AssignmentType<
                  { formula: FormulaField },
                  SimpleMerge<DefaultOptions, DefaultOptions>,
              >,
              { formula: InitializedType<DefaultOptions> },
              { formula: InitializedType<DefaultOptions> },
          >;
          disable: BooleanField<
              { initial: false },
              AssignmentType<SimpleMerge<{ initial: false }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: false }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: false }, DefaultOptions>>,
          >;
          openDistributor: BooleanField<
              { initial: true },
              AssignmentType<SimpleMerge<{ initial: true }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
          >;
          track: StringField<
              {
                  choices: readonly ["fast", "medium", "slow", "custom"];
                  initial: "medium";
              },
              AssignmentType<
                  {
                      choices: readonly ["fast", "medium", "slow", "custom"];
                      initial: "medium";
                  },
              >,
              InitializedType<
                  {
                      choices: readonly ["fast", "medium", "slow", "custom"];
                      initial: "medium";
                  },
              >,
              InitializedType<
                  {
                      choices: readonly ["fast", "medium", "slow", "custom"];
                      initial: "medium";
                  },
              >,
          >;
      }

      The returned value MUST be kept up to sync with the Schema type parameter.

    • Migrate candidate source data for this DataModel which may require initial cleaning or transformations.

      Parameters

      • source: any

        The candidate source data from which the model will be constructed

      Returns AnyMutableObject

      Migrated source data, if necessary

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods