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

    Class DamageType

    A single damage type entry in the DamageTypes registry.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id abbr category color flags? icon? img? isModifier name namespace

    Accessors

    id isEnergy isPhysical isUtility

    Methods

    _initialize localize prepareData defineSchema

    Constructors

    • Parameters

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

      Returns DamageType

    Properties

    _id

    _id: string
    abbr: string

    Abbreviation

    category: keyof readonly ["physical", "energy", "misc"]

    Category

    misc

    color: string

    Color

    flags?: object
    icon?: string

    Icon

    Not used if image is defined

    img?: string

    Image

    Required if no icon is defined.

    isModifier: boolean

    Is not real damage type on its own

    name: string
    namespace: string

    Accessors

    • get id(): string

      The unique key of the value.

      Returns string

    • get isEnergy(): boolean

      Returns boolean

    • get isPhysical(): boolean

      Returns boolean

    • get isUtility(): boolean

      Returns boolean

    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: null; nullable: true; required: false },
              AssignmentType<
                  { blank: false; initial: null; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: false; initial: null; nullable: true; required: false },
              >,
              InitializedType<
                  { blank: false; initial: null; nullable: true; required: false },
              >,
          >;
          category: StringField<
              {
                  blank: false;
                  choices: () => readonly ["physical", "energy", "misc"];
                  initial: "misc";
                  required: true;
              },
              AssignmentType<
                  {
                      blank: false;
                      choices: () => readonly ["physical", "energy", "misc"];
                      initial: "misc";
                      required: true;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => readonly ["physical", "energy", "misc"];
                      initial: "misc";
                      required: true;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => readonly ["physical", "energy", "misc"];
                      initial: "misc";
                      required: true;
                  },
              >,
          >;
          color: StringField<
              { initial: "black"; required: true },
              AssignmentType<{ initial: "black"; required: true }>,
              string,
              string,
          >;
          diceSoNice: SchemaField<
              {
                  colorset: StringField<
                      { required: false },
                      AssignmentType<{ required: false }>,
                      InitializedType<{ required: false }>,
                      InitializedType<{ required: false }>,
                  >;
                  material: StringField<
                      { required: false },
                      AssignmentType<{ required: false }>,
                      InitializedType<{ required: false }>,
                      InitializedType<{ required: false }>,
                  >;
                  texture: StringField<
                      { required: false },
                      AssignmentType<{ required: false }>,
                      InitializedType<{ required: false }>,
                      InitializedType<{ required: false }>,
                  >;
              },
              { initial: undefined; required: false },
              AssignmentType<
                  {
                      colorset: StringField<
                          { required: false },
                          AssignmentType<{ required: false }>,
                          InitializedType<{ required: false }>,
                          InitializedType<{ required: false }>,
                      >;
                      material: StringField<
                          { required: false },
                          AssignmentType<{ required: false }>,
                          InitializedType<{ required: false }>,
                          InitializedType<{ required: false }>,
                      >;
                      texture: StringField<
                          { required: false },
                          AssignmentType<{ required: false }>,
                          InitializedType<{ required: false }>,
                          InitializedType<{ required: false }>,
                      >;
                  },
                  SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
              >,
              {
                  colorset: InitializedType<{ required: false }>;
                  material: InitializedType<{ required: false }>;
                  texture: InitializedType<{ required: false }>;
              },
              {
                  colorset: InitializedType<{ required: false }>;
                  material: InitializedType<{ required: false }>;
                  texture: InitializedType<{ required: false }>;
              },
          >;
          flags: ObjectField<
              { initial: {}; required: false },
              AssignmentType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
          >;
          icon: StringField<
              { initial: ""; required: false },
              AssignmentType<{ initial: ""; required: false }>,
              InitializedType<{ initial: ""; required: false }>,
              InitializedType<{ initial: ""; required: false }>,
          >;
          img: FilePathField<
              { categories: "IMAGE"[] },
              AssignmentType<{ categories: "IMAGE"[] }>,
              InitializedType<{ categories: "IMAGE"[] }>,
              InitializedType<{ categories: "IMAGE"[] }>,
          >;
          isModifier: BooleanField<
              { initial: false; required: false },
              AssignmentType<
                  SimpleMerge<{ initial: false; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: false; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: false; required: false }, DefaultOptions>,
              >,
          >;
          name: StringField<
              { initial: ""; localize: true; required: false },
              AssignmentType<{ initial: ""; localize: true; required: false }>,
              InitializedType<{ initial: ""; localize: true; required: false }>,
              InitializedType<{ initial: ""; localize: true; required: false }>,
          >;
          namespace: StringField<
              { blank: false; required: true },
              AssignmentType<{ blank: false; required: true }>,
              string,
              string,
          >;
          resist: BooleanField<
              { initial: true },
              AssignmentType<SimpleMerge<{ initial: true }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
              InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
          >;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods