Class Material

A single material type entry in the Materials registry.

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Accessors

basic id

Methods

_initialize isAllowed isValidAddon localize prepareData defineSchema

Constructors

constructor

Properties

_id

_id: string

addon

addon: boolean

Is add-on material

allowed

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

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

Armor modifiers

baseMaterial

baseMaterial: string[]

Materials this can be added on top of

dr

dr: boolean

Is this valid for DR choices?

Optionalflags

flags?: object

hardness

hardness: number

hardnessMultiplier

hardnessMultiplier: number

healthBonus

healthBonus: number

healthMultiplier

healthMultiplier: number

healthPerInch

healthPerInch: number

incompatible

incompatible: string[]

Explicit incompatible materials when not otherwise determinable

intrinsic

intrinsic: boolean

Is always available as base material

Such as wood.

masterwork

masterwork: boolean

Is this material always masterworked?

Default Value

false

name

name: string

namespace

namespace: string

price

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

primitive: boolean

Is primitive material

For example: bone, wood, or stone.

shield

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

Shield modifiers

OptionalshortName

shortName?: string

Simpler name when such is known.

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

treatedAs

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

weight: { bonusPerPound: number; multiplier: number }

Weight modifiers

Accessors

basic

id

Methods

_initialize

isAllowed

  • isAllowed(
        source: ItemPF | ItemAction,
        altBaseMaterial?: string,
        altNormalMaterial?: string,
    ): boolean

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

    Parameters

    • source: ItemPF | ItemAction

      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

isValidAddon

  • isValidAddon(material: string | Material): null | boolean

  • 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 null | boolean

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

Protectedlocalize

Protected AbstractprepareData

StaticdefineSchema

  • defineSchema(): {
        _id: any;
        addon: any;
        allowed: any;
        armor: any;
        baseMaterial: any;
        dr: any;
        flags: any;
        hardness: any;
        hardnessMultiplier: any;
        healthBonus: any;
        healthMultiplier: any;
        healthPerInch: any;
        incompatible: any;
        intrinsic: any;
        masterwork: any;
        name: any;
        namespace: any;
        price: any;
        primitive: any;
        shield: any;
        shortName: any;
        treatedAs: any;
        weight: any;
    }

  • Returns {
        _id: any;
        addon: any;
        allowed: any;
        armor: any;
        baseMaterial: any;
        dr: any;
        flags: any;
        hardness: any;
        hardnessMultiplier: any;
        healthBonus: any;
        healthMultiplier: any;
        healthPerInch: any;
        incompatible: any;
        intrinsic: any;
        masterwork: any;
        name: any;
        namespace: any;
        price: any;
        primitive: any;
        shield: any;
        shortName: any;
        treatedAs: any;
        weight: any;
    }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods