ReadonlyentriesThe Collection of index entries this browser is aware of.
A set of filters that were expanded by the user, and should stay expanded upon re-render.
The set of filters to apply to the compendium index.
The types of entries this browser handles, as per a document's type property.
Compendium packs this browser gets entries from.
The current sort order and direction for the entries in the browser.
Include world content
Static_Static InternalBROWSERSKnown browsers.
Initialized in initializeBrowsers
StaticDEFAULT_Static AbstractdocumentThe document name of entries this browser displays.
StaticENTRY_The template used to render individual entries in the browser.
StaticfilterAn array of classes extending BaseFilter that should be used for this browser.
StaticPARTSStaticPURGE_Delay after closing until internal cache is purged
Default to 30 seconds.
Low delay since most of the heavy processing is actually fetching the indexes which has already happened.
StaticsortThe columns used for sorting entries in the browser.
Static AbstracttypeA localisation string used in the browser's title.
Internal ExperimentalEnable queued filters
Protected_ProtectedGet the set of ContextMenu options which should be used for the compendium browser's entries.
Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.
Options provided directly to the constructor
Configured options for the application instance
Protected_ProtectedObfuscate Physical Item information if unidentified
Protected_Actions performed after closing the Application. Post-close steps are not awaited by the close process.
Provided render options
Internal ExperimentalQueue filters to be processed by _activateFilterQueue
Only one filter bundle is ever queued.
InternalAdd global listeners
Comprehensive listeners for ensuring the drag end event is caught.
ProtectedgenerateProtectedinitializeProtectedPerform minimal preparation steps to initialize the compendium browser. Add filters and determine which compendiums include data relevant to this browser.
Check whether a compendium should be included in the browser.
The compendium to test
Whether the compendium should be included
ProtectedloadProtectedLoad a compendium's index to prepare it for browsing.
The compendium to load
The loaded index entries
Perform the initial setup of the compendium browser. This includes requesting the index of all relevant compendiums if necessary and preparing the filters.
Static_Map an entry from a compendium to the format used by the browser.
The entry to map
The compendium the entry is from
The mapped entry
Protected Static_ProtectedFlip the current sort direction.
The triggering event
Protected Static_ProtectedClear singular filter
StaticgetRequest indexes of all packs of a document type to be loaded. This method should only ever be called as CompendiumBrowser.getIndexes to ensure Promises are properly bundled.
The names of the packs to load indexes for
A Promise that resolves once all indexes have been loaded
StaticinitializeInitialize all CompendiumBrowsers found in pf1.applications.compendiumBrowser and register them in pf1.applications.compendiums.
Staticregister
The basic compendium browser class allowing the browsing of compendiums by utilising their indexes.
Extending classes must define the following static properties if the browser is not meant to browse Item documents: documentName. Extending classes should define the following static properties: typeName, filterClasses.