Class Macros

apps

invalidDocumentIds

folders

• get folders(): Collection<string, Folder>

• Reference the set of Folders which contain documents in this collection

  Returns Collection<string, Folder>

documentClass

• get documentClass(): typeof Document

• A reference to the Document class definition which is contained within this DocumentCollection.

  Returns typeof Document

documentName

• get documentName(): any

• Returns any

  Inherit Doc

name

• get name(): string

• The Collection class name

  Returns string

Static instance

• get instance(): WorldCollection

• Return a reference to the singleton instance of this WorldCollection, or null if it has not yet been created.

  Returns WorldCollection

Static registeredSheets

• get registeredSheets(): DocumentSheet[]

• Return an array of currently registered sheet classes for this Document type.

  Returns DocumentSheet[]

  Static

_getVisibleTreeContents

• _getVisibleTreeContents(entry): any

• Parameters

  • entry: any

  Returns any

importFromCompendium

• importFromCompendium(pack, id, updateData?, options?): Promise<Document>

• Import a Document from a Compendium collection, adding it to the current World.

  Parameters

  • pack: CompendiumCollection

    The CompendiumCollection instance from which to import
  • id: string

    The ID of the compendium entry to import
  • Optional updateData: object = {}

    Optional additional data used to modify the imported Document before it is created
  • Optional options: object = {}

    Optional arguments passed to the WorldCollection#fromCompendium and Document.create methods

  Returns Promise<Document>

  The imported Document instance

createDocument

• createDocument(data, context?): Document

• Instantiate a Document for inclusion in the Collection.

  Parameters

  • data: object

    The Document data.
  • Optional context: object = {}

    Document creation context.

  Returns Document

getInvalid

• getInvalid(id, options?): Document

• Obtain a temporary Document instance for a document id which currently has invalid source data.

  Parameters

  • id: string

    A document ID with invalid source data.
  • Optional options: {
        strict: boolean;
    } = {}

    Additional options to configure retrieval.

    • strict: boolean

      Throw an Error if the requested ID is not in the set of invalid IDs for this collection.

  Returns Document

  An in-memory instance for the invalid Document

  Throws

  If strict is true and the requested ID is not in the set of invalid IDs for this collection.

get

• get(id, options?): Document

• Get an element from the DocumentCollection by its ID.

  Parameters

  • id: string

    The ID of the Document to retrieve.
  • Optional options: {
        strict: boolean;
        invalid: boolean;
    } = {}

    Additional options to configure retrieval.

    • strict: boolean

      Throw an Error if the requested Document does not exist.

    • invalid: boolean

      Allow retrieving an invalid Document.

  Returns Document

  Throws

  If strict is true and the Document cannot be found.

set

• set(id, document): void

• Parameters

  • id: any
  • document: any

  Returns void

  Inherit Doc

delete

• delete(id): boolean

• Parameters

  • id: any

  Returns boolean

  Inherit Doc

render

• render(force, options): void

• Render any Applications associated with this DocumentCollection.

  Parameters

  • force: any
  • options: any

  Returns void

search

• search(search): string[]

• 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.

  Parameters

  • search: {
        query: string;
        filters: FieldFilter[];
        exclude: string[];
    }

    An object configuring the search

    • query: string

      A case-insensitive search string

    • filters: FieldFilter[]

      An array of filters to apply

    • exclude: string[]

      An array of document IDs to exclude from search results

  Returns string[]

updateAll

• updateAll(transformation, condition?, options?): Promise<Document[]>

• Update all objects in this DocumentCollection with a provided transformation. Conditionally filter to only apply to Entities which match a certain condition.

  Parameters

  • transformation: object | Function

    An object of data or function to apply to all matched objects
  • condition: Function = null

    A function which tests whether to target each object
  • Optional options: object = {}

    Additional options passed to Document.updateDocuments

  Returns Promise<Document[]>

  An array of updated data once the operation is complete

_onModifyContents

• _onModifyContents(action, documents, result, operation, user): void
• Internal

  Follow-up actions to take when a database operation modifies Documents in this DocumentCollection.

  Parameters

  • action: DatabaseAction

    The database action performed
  • documents: ClientDocument[]

    The array of modified Documents
  • result: any[]

    The result of the database operation
  • operation: DatabaseOperation

    Database operation details
  • user: User

    The User who performed the operation

  Returns void

Static registerSheet

• registerSheet(...args): void

• Register a Document sheet class as a candidate which can be used to display Documents of a given type. See DocumentSheetConfig.registerSheet for details.

  Parameters

  • Rest ...args: any[]

    Arguments forwarded to the DocumentSheetConfig.registerSheet method

  Returns void

  Static

  Example: Register a new ActorSheet subclass for use with certain Actor types.

  Actors.registerSheet("dnd5e", ActorSheet5eCharacter, { types: ["character], makeDefault: true });
  Copy

Static unregisterSheet

• unregisterSheet(...args): void

• Unregister a Document sheet class, removing it from the list of available sheet Applications to use. See DocumentSheetConfig.unregisterSheet for detauls.

  Parameters

  • Rest ...args: any[]

    Arguments forwarded to the DocumentSheetConfig.unregisterSheet method

  Returns void

  Static

  Example: Deregister the default ActorSheet subclass to replace it with others.

  Actors.unregisterSheet("core", ActorSheet);
  Copy

Static getSearchableFields

• getSearchableFields(documentName, documentSubtype?, isEmbedded?): Set<string>

• Get the searchable fields for a given document or index, based on its data model

  Parameters

  • documentName: string

    The document type name
  • Optional documentSubtype: string = ""

    The document subtype name
  • Optional isEmbedded: boolean = false

    Whether the document is an embedded object

  Returns Set<string>

  The dot-delimited property paths of searchable fields