Class Material

A single material type entry in the Materials registry.

Hierarchy

RegistryEntry
- Material

Index

Constructors

constructor

new Material(): Material
Returns Material
Inherited from RegistryEntry.constructor

Accessors

basic

get basic(): boolean
Getter for whether this material is a basic material.

Returns boolean
- Defined in module/registry/materials.mjs:89

id

get id(): string
The unique key of the value.

Returns string
Inherited from RegistryEntry.id
- Defined in module/registry/base-registry.mjs:183

Methods

isAllowed

isAllowed(item): 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
- Defined in module/registry/materials.mjs:99

isValidAddon

isValidAddon(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.
- Defined in module/registry/materials.mjs:170

prepareData

prepareData(): void
Prepares the data of the registry entry.

Returns void
Inherited from RegistryEntry.prepareData
- Defined in module/registry/base-registry.mjs:190

`Static` defineSchema

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;
}
- _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
Overrides RegistryEntry.defineSchema
- Defined in module/registry/materials.mjs:11

Class Material

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Material

Accessors

basic

Returns boolean

id

Returns string

Methods

isAllowed

Parameters

item: ItemPF

Returns boolean

isValidAddon

Parameters

material: string | ItemPF | Material

Returns null | boolean

prepareData

Returns void

Static 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

Settings

Member Visibility

Theme

On This Page

`Static` defineSchema