Class Adventure

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

Index

Constructors

constructor

Methods

Constructors

constructor

new Adventure(): Adventure

Inherited from ClientDocumentMixin(foundry.documents.BaseAdventure).constructor
Returns Adventure

Methods

import

import([options]?: { dialog: boolean }): Promise<AdventureImportResult>

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

Parameters
- [options]: { dialog: boolean } = {}
  
  Options which configure and customize the import process
  - dialog: boolean
Returns Promise<AdventureImportResult>
The import result

prepareImport

prepareImport([options]?: { importFields: string[] }): Promise<AdventureImportData>

Prepare Adventure data for import into the World.

Parameters
- [options]: { importFields: string[] } = {}
  
  Options passed in from the import dialog to configure the import behavior.
  - importFields: string[]
Returns Promise<AdventureImportData>

importContent

importContent(data?: AdventureImportData): Promise<AdventureImportResult>

Execute an Adventure import workflow, creating and updating documents in the World.

Parameters
- data: AdventureImportData = {}
  
  Prepared adventure data to import
Returns Promise<AdventureImportResult>
The import result