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

    Class Source

    The Base Registry Object class, providing shared functionality for all registry objects in the system. For the required data, see defineSchema.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id abbr? date? flags? isbn? legacy? level? name namespace pages? publisher? tieIn? type? url? TYPES

    Accessors

    id

    Methods

    _initialize localize prepareData defineSchema

    Constructors

    • Parameters

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

      Returns Source

    Properties

    _id

    _id: string
    abbr?: string

    Abbreviation

    date?: number
    flags?: object
    isbn?: string
    legacy?: boolean

    D&D 3.5 material

    level?: number

    Starting level of the adventure

    name: string
    namespace: string
    pages?: number

    Page count

    publisher?: string
    Paizo
    tieIn?: string
    type?: readonly [
        "core",
        "setting",
        "ap",
        "module",
        "companion",
        "pg",
        "comic",
        "pfs",
    ]
    url?: string
    TYPES: readonly [
        "core",
        "setting",
        "ap",
        "module",
        "companion",
        "pg",
        "comic",
        "pfs",
    ] = ...

    An array of allowed types of sources.

    core: Core book companion: Player companion setting: Campaign setting book ap: Adventure path pg: Adventure path - player guide comic: Comic pfs: Pathfinder Society module: Module

    Accessors

    • get id(): string

      The unique key of the value.

      Returns string

    Methods

    _initialize

    • _initialize(): void
      Internal

      Returns void

    • Protected

      Localize fields

      Returns void

    • Protected

      Prepares the data of the registry entry.

      Returns void

    • Returns {
          _id: StringField<
              { blank: false; readonly: true; required: true },
              AssignmentType<{ blank: false; readonly: true; required: true }>,
              string,
              string,
          >;
          abbr: StringField<
              { blank: false; initial: undefined; nullable: false; required: false },
              AssignmentType<
                  { blank: false; initial: undefined; nullable: false; required: false },
              >,
              InitializedType<
                  { blank: false; initial: undefined; nullable: false; required: false },
              >,
              InitializedType<
                  { blank: false; initial: undefined; nullable: false; required: false },
              >,
          >;
          date: DateField;
          flags: ObjectField<
              { initial: {}; required: false },
              AssignmentType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
          >;
          isbn: StringField<
              { blank: true; initial: undefined; nullable: true; required: false },
              AssignmentType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
          >;
          legacy: BooleanField<
              { initial: false; label: "D&D 3.5 Material"; required: false },
              AssignmentType<
                  SimpleMerge<
                      { initial: false; label: "D&D 3.5 Material"; required: false },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initial: false; label: "D&D 3.5 Material"; required: false },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initial: false; label: "D&D 3.5 Material"; required: false },
                      DefaultOptions,
                  >,
              >,
          >;
          level: NumberField<
              {
                  initial: undefined;
                  integer: true;
                  label: "Starting level";
                  min: 1;
                  required: false;
              },
              AssignmentType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Starting level";
                      min: 1;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Starting level";
                      min: 1;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Starting level";
                      min: 1;
                      required: false;
                  },
              >,
          >;
          name: StringField<
              { blank: false; nullable: false; required: true },
              AssignmentType<{ blank: false; nullable: false; required: true }>,
              string,
              string,
          >;
          namespace: StringField<
              { blank: false; required: true },
              AssignmentType<{ blank: false; required: true }>,
              string,
              string,
          >;
          pages: NumberField<
              {
                  initial: undefined;
                  integer: true;
                  label: "Page count";
                  min: 1;
                  required: false;
              },
              AssignmentType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Page count";
                      min: 1;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Page count";
                      min: 1;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Page count";
                      min: 1;
                      required: false;
                  },
              >,
          >;
          publisher: StringField<
              { blank: false; initial: "Paizo"; nullable: false; required: false },
              AssignmentType<
                  { blank: false; initial: "Paizo"; nullable: false; required: false },
              >,
              InitializedType<
                  { blank: false; initial: "Paizo"; nullable: false; required: false },
              >,
              InitializedType<
                  { blank: false; initial: "Paizo"; nullable: false; required: false },
              >,
          >;
          tieIn: StringField<
              { blank: true; initial: undefined; nullable: true; required: false },
              AssignmentType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
          >;
          type: StringField<
              { blank: true; initial: undefined; nullable: true; required: false },
              AssignmentType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: true; initial: undefined; nullable: true; required: false },
              >,
          >;
          url: URLField;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods