Static
configureChange ownership of a document by rendering a dialog to alter the default and all user / player ownership.
Document instance to modify.
Optional
options: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The modified document or 'null' if the user closed the
dialog via <Esc>
or the close header button.
Static
documentCreate a new Document of the type specified by documentCls
by rendering a dialog window to provide basic
creation details.
Document class to create.
Optional
data: objectDocument data.
Optional
context: { Additional context options or dialog positioning options.
Optional
options?: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
pack?: objectA Compendium pack identifier within which the Documents should be modified.
Optional
parent?: objectA parent Document within which these Documents should be embedded.
Optional
renderRender the sheet for the new document.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The newly created document or a falsy value; either 'false'
for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
documentShows a modal / non-draggable dialog to delete a document.
Document to delete.
Optional
opts: { Additional context options or dialog positioning options.
Optional
context?: objectDocumentModificationContext.
Optional
options?: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The document if deleted or a falsy value; either
'false' for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
folderCreate a new Folder by rendering a dialog window to provide basic creation details.
Initial data with which to populate the creation form.
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The newly created Folder or null if the dialog is closed.
Static
folderDeletes a folder and does delete subfolders / documents.
Folder to delete.
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The deleted Folder or a falsy value; either 'false' for
cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
folderShows a modal / non-draggable dialog to export a folder to an eligible compendium pack.
Folder to export.
Optional
opts: { Additional options.
Optional
keepKeep document IDs.
Optional
merge?: booleanUpdate existing entries in the Compendium pack, matching by name
Optional
options?: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
pack?: stringThe name of the compendium pack to provide an initial selection value in the dialog.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The compendium collection the folder is exported
to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
folderRemoves a folder, but does not delete / remove sub-folders / documents.
Folder to remove.
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The removed Folder or a falsy value; either 'false' for
cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
folderCreate a RollTable from the contents of the Folder.
Folder to create roll table from...
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The newly created RollTable or a falsy value; either
'false' for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
folderUpdates an existing Folder by rendering a dialog window with basic details.
The folder to edit.
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The modified Folder or null if the dialog is closed.
Static
importRender an import dialog for updating the data related to this Document through an exported JSON file
The document to import JSON to...
Optional
options: SvelteApplicationOptionsOptions to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The document after import completes or a falsy value;
either 'false' for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header
button.
Provides several methods to create documents, folders, and modify them through use of TJSDialog and a modal and non-draggable by default user experience.