Class Material

A single material type entry in the Materials registry.

Hierarchy (View Summary)

Constructors

constructor

Properties

_id flags? name namespace

Accessors

basic id

Methods

_initialize isAllowed isValidAddon localize prepareData defineSchema

Constructors

constructor

Properties

_id

_id: string

Optionalflags

flags?: object

name

name: string

namespace

namespace: string

Accessors

basic

id

Methods

_initialize

isAllowed

  • isAllowed(item: ItemPF): boolean

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

    Parameters

    • item: ItemPF

      Whether we're checking weapons or equipment

    Returns boolean

    • Whether the material is allowed for the given item

isValidAddon

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

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

    Parameters

    • material: string | ItemPF | Material

      Item, 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