[Feature] NPC Actors (#1949)

module/applications/sheets-configs/_module.mjs

@@ -2,6 +2,7 @@ export { default as ActionConfig } from './action-config.mjs';
 export { default as ActionSettingsConfig } from './action-settings-config.mjs';
 export { default as CharacterSettings } from './character-settings.mjs';
 export { default as AdversarySettings } from './adversary-settings.mjs';
+export { default as NPCSettings } from './npc-settings.mjs';
 export { default as CompanionSettings } from './companion-settings.mjs';
 export { default as SettingFeatureConfig } from './setting-feature-config.mjs';
 export { default as EnvironmentSettings } from './environment-settings.mjs';

module/applications/sheets-configs/npc-settings.mjs

@@ -0,0 +1,85 @@
+import DHBaseActorSettings from '../sheets/api/actor-setting.mjs';
+
+/**@typedef {import('@client/applications/_types.mjs').ApplicationClickAction} ApplicationClickAction */
+
+export default class DHNPCSettings extends DHBaseActorSettings {
+    /**@inheritdoc */
+    static DEFAULT_OPTIONS = {
+        classes: ['npc-settings'],
+        position: { width: 455, height: 'auto' },
+        actions: {},
+        dragDrop: [
+            { dragSelector: null, dropSelector: '.tab.features' },
+            { dragSelector: '.feature-item', dropSelector: null }
+        ]
+    };
+
+    /**@override */
+    static PARTS = {
+        header: {
+            id: 'header',
+            template: 'systems/daggerheart/templates/sheets-settings/npc-settings/header.hbs'
+        },
+        tabs: { template: 'systems/daggerheart/templates/sheets/global/tabs/tab-navigation.hbs' },
+        details: {
+            id: 'details',
+            template: 'systems/daggerheart/templates/sheets-settings/npc-settings/details.hbs'
+        },
+        features: {
+            id: 'features',
+            template: 'systems/daggerheart/templates/sheets-settings/npc-settings/features.hbs'
+        }
+    };
+
+    /** @override */
+    static TABS = {
+        primary: {
+            tabs: [{ id: 'details' }, { id: 'features' }],
+            initial: 'details',
+            labelPrefix: 'DAGGERHEART.GENERAL.Tabs'
+        }
+    };
+
+    async _prepareContext(options) {
+        const context = await super._prepareContext(options);
+
+        const featureForms = ['passive', 'action', 'reaction'];
+        context.features = context.document.system.features.sort((a, b) =>
+            a.system.featureForm !== b.system.featureForm
+                ? featureForms.indexOf(a.system.featureForm) - featureForms.indexOf(b.system.featureForm)
+                : a.sort - b.sort
+        );
+
+        return context;
+    }
+
+    /* -------------------------------------------- */
+
+    async _onDragStart(event) {
+        const featureItem = event.currentTarget.closest('.feature-item');
+
+        if (featureItem) {
+            const feature = this.actor.items.get(featureItem.id);
+            const featureData = { type: 'Item', uuid: feature.uuid, fromInternal: true };
+            event.dataTransfer.setData('text/plain', JSON.stringify(featureData));
+            event.dataTransfer.setDragImage(featureItem.querySelector('img'), 60, 0);
+        }
+    }
+
+    async _onDrop(event) {
+        event.stopPropagation();
+        const data = foundry.applications.ux.TextEditor.implementation.getDragEventData(event);
+
+        const item = await fromUuid(data.uuid);
+        if (item?.type === 'feature') {
+            if (data.fromInternal && item.parent?.uuid === this.actor.uuid) {
+                return;
+            }
+
+            const itemData = item.toObject();
+            delete itemData._id;
+
+            await this.actor.createEmbeddedDocuments('Item', [itemData]);
+        }
+    }
+}

module/applications/sheets/actors/_module.mjs

@@ -2,4 +2,5 @@ export { default as Adversary } from './adversary.mjs';
 export { default as Character } from './character.mjs';
 export { default as Companion } from './companion.mjs';
 export { default as Environment } from './environment.mjs';
+export { default as NPC } from './npc.mjs';
 export { default as Party } from './party.mjs';

module/applications/sheets/actors/npc.mjs

@@ -0,0 +1,136 @@
+import DHBaseActorSheet from '../api/base-actor.mjs';
+
+export default class NPCSheet extends DHBaseActorSheet {
+    /** @inheritDoc */
+    static DEFAULT_OPTIONS = {
+        classes: ['npc'],
+        position: { width: 660, height: 600 },
+        window: { resizable: true },
+        actions: {},
+        window: {
+            resizable: true,
+            controls: [
+                {
+                    icon: 'fa-solid fa-signature',
+                    label: 'DAGGERHEART.UI.Tooltip.configureAttribution',
+                    action: 'editAttribution'
+                }
+            ]
+        },
+        dragDrop: [
+            {
+                dragSelector: '[data-item-id][draggable="true"], [data-item-id] [draggable="true"]',
+                dropSelector: null
+            }
+        ]
+    };
+
+    static PARTS = {
+        header: { template: 'systems/daggerheart/templates/sheets/actors/npc/header.hbs' },
+        tabs: { template: 'systems/daggerheart/templates/sheets/actors/npc/navigation.hbs' },
+        features: {
+            template: 'systems/daggerheart/templates/sheets/actors/npc/features.hbs',
+            scrollable: ['.feature-section']
+        },
+        notes: {
+            template: 'systems/daggerheart/templates/sheets/actors/npc/notes.hbs'
+        }
+    };
+
+    /** @inheritdoc */
+    static TABS = {
+        primary: {
+            tabs: [{ id: 'notes' }, { id: 'features' }],
+            initial: 'notes',
+            labelPrefix: 'DAGGERHEART.GENERAL.Tabs'
+        }
+    };
+
+    /** @inheritdoc */
+    _prepareTabs(group) {
+        const result = super._prepareTabs(group);
+        if (group === 'primary') {
+            result.features.empty = this.document.system.features.length === 0;
+        }
+        return result;
+    }
+
+    /** @inheritdoc */
+    async _preparePartContext(partId, context, options) {
+        context = await super._preparePartContext(partId, context, options);
+        switch (partId) {
+            case 'header':
+                await this._prepareHeaderContext(context, options);
+                break;
+            case 'features':
+                await this._prepareFeaturesContext(context, options);
+                break;
+            case 'notes':
+                await this._prepareNotesContext(context, options);
+                break;
+        }
+
+        return context;
+    }
+
+    /**
+     * Prepare render context for the Header part.
+     * @param {ApplicationRenderContext} context
+     * @param {ApplicationRenderOptions} options
+     * @returns {Promise<void>}
+     * @protected
+     */
+    async _prepareHeaderContext(context, _options) {
+        const { system } = this.document;
+        const { TextEditor } = foundry.applications.ux;
+
+        context.description = await TextEditor.implementation.enrichHTML(system.description, {
+            secrets: this.document.isOwner,
+            relativeTo: this.document
+        });
+    }
+
+    /**
+     * Prepare render context for the Features part.
+     * @param {ApplicationRenderContext} context
+     * @param {ApplicationRenderOptions} options
+     * @returns {Promise<void>}
+     * @protected
+     */
+    async _prepareFeaturesContext(context, _options) {
+        const featureForms = ['passive', 'action', 'reaction'];
+        context.features = this.document.system.features.sort((a, b) =>
+            a.system.featureForm !== b.system.featureForm
+                ? featureForms.indexOf(a.system.featureForm) - featureForms.indexOf(b.system.featureForm)
+                : a.sort - b.sort
+        );
+    }
+
+    /**
+     * Prepare render context for the Biography part.
+     * @param {ApplicationRenderContext} context
+     * @param {ApplicationRenderOptions} options
+     * @returns {Promise<void>}
+     * @protected
+     */
+    async _prepareNotesContext(context, _options) {
+        const { system } = this.document;
+        const { TextEditor } = foundry.applications.ux;
+
+        const paths = {
+            notes: 'notes'
+        };
+
+        for (const [key, path] of Object.entries(paths)) {
+            const value = foundry.utils.getProperty(system, path);
+            context[key] = {
+                field: system.schema.getField(path),
+                value,
+                enriched: await TextEditor.implementation.enrichHTML(value, {
+                    secrets: this.document.isOwner,
+                    relativeTo: this.document
+                })
+            };
+        }
+    }
+}

module/data/actor/_module.mjs

@@ -1,15 +1,17 @@
 import DhCharacter from './character.mjs';
 import DhCompanion from './companion.mjs';
 import DhAdversary from './adversary.mjs';
+import DhNPC from './npc.mjs';
 import DhEnvironment from './environment.mjs';
 import DhParty from './party.mjs';
 
-export { DhCharacter, DhCompanion, DhAdversary, DhEnvironment, DhParty };
+export { DhCharacter, DhCompanion, DhAdversary, DhNPC, DhEnvironment, DhParty };
 
 export const config = {
     character: DhCharacter,
     companion: DhCompanion,
     adversary: DhAdversary,
+    npc: DhNPC,
     environment: DhEnvironment,
     party: DhParty
 };

module/data/actor/npc.mjs

@@ -0,0 +1,43 @@
+import DHNPCSettings from '../../applications/sheets-configs/npc-settings.mjs';
+import BaseDataActor from './base.mjs';
+
+export default class DhpNPC extends BaseDataActor {
+    static LOCALIZATION_PREFIXES = ['DAGGERHEART.ACTORS.NPC'];
+
+    static get metadata() {
+        return foundry.utils.mergeObject(super.metadata, {
+            label: 'TYPES.Actor.npc',
+            type: 'npc',
+            settingSheet: DHNPCSettings,
+            hasResistances: false,
+            hasAttribution: true
+        });
+    }
+
+    static defineSchema() {
+        const fields = foundry.data.fields;
+        return {
+            ...super.defineSchema(),
+            difficulty: new fields.NumberField({
+                nullable: true,
+                initial: null,
+                integer: true,
+                label: 'DAGGERHEART.GENERAL.difficulty'
+            }),
+            description: new fields.HTMLField({ label: 'DAGGERHEART.GENERAL.description' }),
+            motives: new fields.StringField(),
+            notes: new fields.HTMLField()
+        };
+    }
+
+    /**@inheritdoc */
+    static DEFAULT_ICON = 'systems/daggerheart/assets/icons/documents/actors/drama-masks.svg';
+
+    get features() {
+        return this.parent.items.filter(x => x.type === 'feature');
+    }
+
+    isItemValid(source) {
+        return super.isItemValid(source) || source.type === 'feature';
+    }
+}

module/documents/actor.mjs

@@ -109,6 +109,14 @@ export default class DhpActor extends Actor {
             });
         }
 
+        if (this.type === 'npc') {
+            Object.assign(update, {
+                prototypeToken: {
+                    disposition: CONST.TOKEN_DISPOSITIONS.FRIENDLY
+                }
+            });
+        }
+
         this.updateSource(update);
     }