Class Source

The Base Registry Object class, providing shared functionality for all registry objects in the system. For the required data, see defineSchema.

Hierarchy (View Summary)

RegistryEntry
- Source

Index

Constructors

constructor

Properties

_id abbr? date? flags? isbn? legacy? level? name namespace pages? publisher? tieIn? type? url? TYPES

Accessors

Methods

_initialize localize prepareData defineSchema

Constructors

constructor

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

Properties

_id

_id: string

`Optional`abbr

abbr?: string

Abbreviation

`Optional`date

date?: number

`Optional`flags

flags?: object

`Optional`isbn

isbn?: string

`Optional`legacy

legacy?: boolean

D&D 3.5 material

`Optional`level

level?: number

Starting level of the adventure

name

name: string

namespace

namespace: string

`Optional`pages

pages?: number

Page count

`Optional`publisher

publisher?: string

Default Value

Paizo

`Optional`tieIn

tieIn?: string

`Optional`type

type?: readonly [
    "core",
    "setting",
    "ap",
    "module",
    "companion",
    "pg",
    "comic",
    "pfs",
]

`Optional`url

url?: string

`Static` `Internal`TYPES

TYPES: readonly [
    "core",
    "setting",
    "ap",
    "module",
    "companion",
    "pg",
    "comic",
    "pfs",
] = ...

An array of allowed types of sources.

core: Core book companion: Player companion setting: Campaign setting book ap: Adventure path pg: Adventure path - player guide comic: Comic pfs: Pathfinder Society module: Module

Accessors

id

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

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

Methods

_initialize

_initialize(): void
Internal
Returns void
Inherited from RegistryEntry._initialize
- Defined in module/registry/base-registry.mjs:205

`Protected`localize

localize(): void
Protected
Localize fields

Returns void
Inherited from RegistryEntry.localize
- Defined in module/registry/base-registry.mjs:224

`Protected` `Abstract`prepareData

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

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

`Static`defineSchema

defineSchema(): {
    _id: any;
    abbr: any;
    date: DateField;
    flags: any;
    isbn: any;
    legacy: any;
    level: any;
    name: any;
    namespace: any;
    pages: any;
    publisher: any;
    tieIn: any;
    type: any;
    url: URLField;
}
Returns {
    _id: any;
    abbr: any;
    date: DateField;
    flags: any;
    isbn: any;
    legacy: any;
    level: any;
    name: any;
    namespace: any;
    pages: any;
    publisher: any;
    tieIn: any;
    type: any;
    url: URLField;
}
Overrides RegistryEntry.defineSchema
- Defined in module/registry/sources.mjs:30

Class Source

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Source

Properties

_id

Optionalabbr

Optionaldate

Optionalflags

Optionalisbn

Optionallegacy

Optionallevel

name

namespace

Optionalpages

Optionalpublisher

Default Value

OptionaltieIn

Optionaltype

Optionalurl

Static InternalTYPES

Accessors

id

Returns string

Methods

_initialize

Returns void

Protectedlocalize

Returns void

Protected AbstractprepareData

Returns void

StaticdefineSchema

Returns { _id: any; abbr: any; date: DateField; flags: any; isbn: any; legacy: any; level: any; name: any; namespace: any; pages: any; publisher: any; tieIn: any; type: any; url: URLField;}

Settings

On This Page

`Optional`abbr

`Optional`date

`Optional`flags

`Optional`isbn

`Optional`legacy

`Optional`level

`Optional`pages

`Optional`publisher

`Optional`tieIn

`Optional`type

`Optional`url

`Static` `Internal`TYPES

`Protected`localize

`Protected` `Abstract`prepareData

`Static`defineSchema

Returns {
_id: any;
abbr: any;
date: DateField;
flags: any;
isbn: any;
legacy: any;
level: any;
name: any;
namespace: any;
pages: any;
publisher: any;
tieIn: any;
type: any;
url: URLField;
}