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

    Class Material

    A single material type entry in the Materials registry.

    Hierarchy (View Summary)

    Index

    General

    constructor _id addon allowed armor baseMaterial dr flags hardness hardnessMultiplier healthBonus healthMultiplier healthPerInch incompatible intrinsic masterwork name namespace price primitive shield shortName? treatedAs weight basic id isAllowed isValidAddon localize

    Document

    _safePrepareData prepareData

    General

    _id

    _id: string

    Raw ID

    addon: boolean

    Is add-on material

    allowed: {
        buckler: boolean;
        heavyArmor: boolean;
        heavyShield: boolean;
        lightArmor: boolean;
        lightBlade: boolean;
        lightShield: boolean;
        mediumArmor: boolean;
        oneHandBlade: boolean;
        rangedWeapon: boolean;
        towerShield: boolean;
        twoHandBlade: boolean;
    }

    What type of gear is this material allowed on?

    armor: { acp: number; asf: number; maxDex: number }

    Armor modifiers

    baseMaterial: Set<string>

    Materials this can be added on top of

    dr: boolean

    Is this valid for DR choices?

    flags: object

    Freeform data

    hardness: number
    hardnessMultiplier: number
    healthBonus: number
    healthMultiplier: number
    healthPerInch: number
    incompatible: Set<string>

    Explicit incompatible materials when not otherwise determinable

    intrinsic: boolean

    Is always available as base material

    Such as wood.

    masterwork: boolean

    Is this material always masterworked?

    false

    name: string

    Name

    namespace: string

    Source package ID

    price: {
        ammunition: number;
        enhancement: { weapon: number };
        heavyArmor: number;
        lightArmor: number;
        lightWeapon: number;
        mediumArmor: number;
        multiplier: number;
        oneHandWeapon: number;
        perPound: number;
        rangedOneHandWeapon: number;
        rangedTwoHandWeapon: number;
        shield: number;
        twoHandWeapon: number;
    }

    Price modifiers

    primitive: boolean

    Is primitive material

    For example: bone, wood, or stone.

    shield: { acp: number; asf: number; maxDex: number }

    Shield modifiers

    shortName?: string

    Simpler name when such is known.

    For example, "alchemical silver" is more commonly referred to simply as "silver"

    treatedAs: string

    Behaves for DR/ER exactly the same as another material.

    For example, mithral counts as silver in all regards, there is nothing that has DR penetrated by mithral specifically.

    weight: { bonusPerPound: number; multiplier: number }

    Weight modifiers

    • get basic(): boolean

      Is this a basic material that items without special materials are made of?

      Returns boolean

    • get id(): string

      The unique key of the value.

      Returns string

    • Check if a given material is okay to be added to our materials list

      Parameters

      • source: ItemPF | Action

        Whether we're checking weapons, equipment, or actions

      • altBaseMaterial: string = null

        An alternative base material to check against

      • altNormalMaterial: string = null

        An alternative normal material to check against

      Returns boolean

      • Whether the material is allowed for the given item or action

    • Check if a given addon material is valid for the chosen material

      Parameters

      • material: string | Material

        Material or material ID for which to test if this addon is valid.

      Returns boolean | null

      • Null if the provided parameter is invalid, boolean otherwise.
    • Protected

      Localize fields

      Returns void

    Document

    _safePrepareData

    • _safePrepareData(): void
      Internal

      Safely prepare data

      Returns void

    • Protected

      Prepare data after initialization or reset.

      Returns void

    Settings

    Member Visibility

    On This Page

    General
    Document