Return the subset of Playlist documents which are currently playing
Reference the set of Folders which contain documents in this collection
Return a reference to the SidebarDirectory application for this WorldCollection.
A reference to the Document class definition which is contained within this DocumentCollection.
The Collection class name
Return a reference to the singleton instance of this WorldCollection, or null if it has not yet been created.
Return an array of currently registered sheet classes for this Document type.
Perform one-time initialization to begin playback of audio
Handle changes to a Scene to determine whether to trigger changes to Playlist documents.
The Scene document being updated
The incremental update data
Import a Document from a Compendium collection, adding it to the current World.
The CompendiumCollection instance from which to import
The ID of the compendium entry to import
The imported Document instance
Apply data transformations when importing a Document from a Compendium pack
The source Document, or a plain data object
Additional options which modify how the document is imported
The processed data ready for world Document creation
Instantiate a Document for inclusion in the Collection.
The Document data.
Obtain a temporary Document instance for a document id which currently has invalid source data.
A document ID with invalid source data.
Additional options to configure retrieval.
An in-memory instance for the invalid Document
Get an element from the DocumentCollection by its ID.
The ID of the Document to retrieve.
Additional options to configure retrieval.
Render any Applications associated with this DocumentCollection.
Find all Documents which match a given search term using a full-text search against their indexed HTML fields and their name. If filters are provided, results are filtered to only those that match the provided values.
An object configuring the search
Update all objects in this DocumentCollection with a provided transformation. Conditionally filter to only apply to Entities which match a certain condition.
An object of data or function to apply to all matched objects
A function which tests whether to target each object
An array of updated data once the operation is complete
Preliminary actions taken before a set of Documents in this Collection are created.
An Array of created data objects
Options which modified the creation operation
The ID of the User who triggered the operation
Follow-up actions taken after a set of Documents in this Collection are created.
An Array of created Documents
An Array of created data objects
Options which modified the creation operation
The ID of the User who triggered the operation
Preliminary actions taken before a set of Documents in this Collection are updated.
An Array of incremental data objects
Options which modified the update operation
The ID of the User who triggered the operation
Follow-up actions taken after a set of Documents in this Collection are updated.
An Array of updated Documents
An Array of incremental data objects
Options which modified the update operation
The ID of the User who triggered the operation
Preliminary actions taken before a set of Documents in this Collection are deleted.
An Array of document IDs being deleted
Options which modified the deletion operation
The ID of the User who triggered the operation
Follow-up actions taken after a set of Documents in this Collection are deleted.
An Array of deleted Documents
An Array of document IDs being deleted
Options which modified the deletion operation
The ID of the User who triggered the operation
Handle shifting documents in a deleted folder to a new parent folder.
The parent folder to which documents should be shifted
The ID of the folder being deleted
Whether to delete the contents of the folder
An array of document IDs to deleted
Register a Document sheet class as a candidate which can be used to display Documents of a given type. See DocumentSheetConfig.registerSheet for details.
Arguments forwarded to the DocumentSheetConfig.registerSheet method
Unregister a Document sheet class, removing it from the list of available sheet Applications to use. See DocumentSheetConfig.unregisterSheet for detauls.
Arguments forwarded to the DocumentSheetConfig.unregisterSheet method
Get the searchable fields for a given document or index, based on its data model
The document type name
The dot-delimited property paths of searchable fields
An Array of application references which will be automatically updated when the collection content changes
Record the set of document ids where the Document was not initialized because of invalid source data
The singleton collection of Playlist documents which exist within the active World. This Collection is accessible within the Game object as game.playlists.
Playlist The Playlist document
PlaylistDirectory The PlaylistDirectory sidebar directory