The client-side Adventure document which extends the common foundry.documents.BaseAdventure model.

Mixes

ClientDocumentMixin

Hook Events

hookEvents.preImportAdventure emitted by Adventure#import hookEvents.importAdventure emitted by Adventure#import

Hierarchy

  • any
    • Adventure

Methods

  • Perform a full import workflow of this Adventure. Create new and update existing documents within the World.

    Parameters

    • Optional options: {
          dialog: boolean;
      } = {}

      Options which configure and customize the import process

      • dialog: boolean

        Display a warning dialog if existing documents would be overwritten

    Returns Promise<AdventureImportResult>

    The import result

  • Prepare Adventure data for import into the World.

    Parameters

    • Optional options: {
          importFields: string[];
      } = {}

      Options passed in from the import dialog to configure the import behavior.

      • importFields: string[]

        A subset of adventure fields to import.

    Returns Promise<AdventureImportData>

  • Parameters

    • source: any
    • options: {} = {}

      Returns any

      Inherit Doc