89 lines
3.7 KiB
JavaScript
89 lines
3.7 KiB
JavaScript
|
import Document from "../abstract/document.mjs";
|
||
|
|
import {mergeObject} from "../utils/helpers.mjs";
|
||
|
|
import * as documents from "./_module.mjs";
|
||
|
|
import * as fields from "../data/fields.mjs"
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {import("./_types.mjs").AdventureData} AdventureData
|
||
|
|
* @typedef {import("../types.mjs").DocumentConstructionContext} DocumentConstructionContext
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The Adventure Document.
|
||
|
|
* Defines the DataSchema and common behaviors for an Adventure which are shared between both client and server.
|
||
|
|
* @mixes AdventureData
|
||
|
|
*/
|
||
|
|
export default class BaseAdventure extends Document {
|
||
|
|
/**
|
||
|
|
* Construct an Adventure document using provided data and context.
|
||
|
|
* @param {Partial<AdventureData>} data Initial data used to construct the Adventure.
|
||
|
|
* @param {DocumentConstructionContext} context Construction context options.
|
||
|
|
*/
|
||
|
|
constructor(data, context) {
|
||
|
|
super(data, context);
|
||
|
|
}
|
||
|
|
|
||
|
|
/* -------------------------------------------- */
|
||
|
|
/* Model Configuration */
|
||
|
|
/* -------------------------------------------- */
|
||
|
|
|
||
|
|
/** @inheritdoc */
|
||
|
|
static metadata = Object.freeze(mergeObject(super.metadata, {
|
||
|
|
name: "Adventure",
|
||
|
|
collection: "adventures",
|
||
|
|
compendiumIndexFields: ["_id", "name", "description", "img", "sort", "folder"],
|
||
|
|
label: "DOCUMENT.Adventure",
|
||
|
|
labelPlural: "DOCUMENT.Adventures",
|
||
|
|
schemaVersion: "12.324"
|
||
|
|
}, {inplace: false}));
|
||
|
|
|
||
|
|
/** @inheritdoc */
|
||
|
|
static defineSchema() {
|
||
|
|
return {
|
||
|
|
_id: new fields.DocumentIdField(),
|
||
|
|
name: new fields.StringField({required: true, blank: false, label: "ADVENTURE.Name", hint: "ADVENTURE.NameHint", textSearch: true}),
|
||
|
|
img: new fields.FilePathField({categories: ["IMAGE"], label: "ADVENTURE.Image", hint: "ADVENTURE.ImageHint"}),
|
||
|
|
caption: new fields.HTMLField({label: "ADVENTURE.Caption", hint: "ADVENTURE.CaptionHint"}),
|
||
|
|
description: new fields.HTMLField({label: "ADVENTURE.Description", hint: "ADVENTURE.DescriptionHint", textSearch: true}),
|
||
|
|
actors: new fields.SetField(new fields.EmbeddedDataField(documents.BaseActor)),
|
||
|
|
combats: new fields.SetField(new fields.EmbeddedDataField(documents.BaseCombat)),
|
||
|
|
items: new fields.SetField(new fields.EmbeddedDataField(documents.BaseItem)),
|
||
|
|
journal: new fields.SetField(new fields.EmbeddedDataField(documents.BaseJournalEntry)),
|
||
|
|
scenes: new fields.SetField(new fields.EmbeddedDataField(documents.BaseScene)),
|
||
|
|
tables: new fields.SetField(new fields.EmbeddedDataField(documents.BaseRollTable)),
|
||
|
|
macros: new fields.SetField(new fields.EmbeddedDataField(documents.BaseMacro)),
|
||
|
|
cards: new fields.SetField(new fields.EmbeddedDataField(documents.BaseCards)),
|
||
|
|
playlists: new fields.SetField(new fields.EmbeddedDataField(documents.BasePlaylist)),
|
||
|
|
folders: new fields.SetField(new fields.EmbeddedDataField(documents.BaseFolder)),
|
||
|
|
folder: new fields.ForeignDocumentField(documents.BaseFolder),
|
||
|
|
sort: new fields.IntegerSortField(),
|
||
|
|
flags: new fields.ObjectField(),
|
||
|
|
_stats: new fields.DocumentStatsField()
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
/* -------------------------------------------- */
|
||
|
|
/* Model Properties */
|
||
|
|
/* -------------------------------------------- */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An array of the fields which provide imported content from the Adventure.
|
||
|
|
* @type {Record<string, typeof Document>}
|
||
|
|
*/
|
||
|
|
static get contentFields() {
|
||
|
|
const content = {};
|
||
|
|
for ( const field of this.schema ) {
|
||
|
|
if ( field instanceof fields.SetField ) content[field.name] = field.element.model.implementation;
|
||
|
|
}
|
||
|
|
return content;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provide a thumbnail image path used to represent the Adventure document.
|
||
|
|
* @type {string}
|
||
|
|
*/
|
||
|
|
get thumbnail() {
|
||
|
|
return this.img;
|
||
|
|
}
|
||
|
|
}
|