Class CompendiumArt

A class responsible for managing package-provided art and applying it to Documents in compendium packs.

Hierarchy

Map
- CompendiumArt

Index

Constructors

constructor

new CompendiumArt(
iterable?: Iterable<[string, CompendiumArtInfo], any, any> | null,
): CompendiumArt
Parameters
- Optionaliterable: Iterable<[string, CompendiumArtInfo], any, any> | null
Returns CompendiumArt
Overrides Map.constructor

Properties

enabled

enabled: boolean = true

Whether art application is enabled. This should be switched off when performing client-side compendium migrations in order to avoid persisting injected data.

FLAG

FLAG: string = "compendiumArtMappings"

The key for the package manifest flag used to store the mapping information.

SETTING

SETTING: string = "compendiumArtConfiguration"

The key for the setting used to store the World's art preferences.

Methods

_registerArt

_registerArt(): Promise<void>
Internal
Collate Document art mappings from active packages.

Returns Promise<void>

applyArt

applyArt(
    documentClass: typeof Document,
    source: object,
    packId?: string,
): object
Apply any art configured for a Document to its source data as it is initialized from a compendium pack.
Parameters
- documentClass: typeof Document
  The class of the Document being initialized.
- source: object
  The Document's source data.
- OptionalpackId: string
  The ID of the compendium pack the Document is initialized from.
Returns object
The Document's source data.

getPackages

getPackages(): CompendiumArtDescriptor[]
Retrieve all active packages that provide art mappings in priority order.

Returns CompendiumArtDescriptor[]

Class CompendiumArt

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CompendiumArt

Properties

enabled

FLAG

SETTING

Methods

_registerArt

Returns Promise<void>

applyArt

Parameters

Returns object

getPackages

Returns CompendiumArtDescriptor[]

Settings

On This Page