[Feature] Summon Action Implementation (#1514)

* Schema definition for DHSummonAction

* Will reimplement

* HBS idea formed. Need to recheck drag drop implementation

* Tried to refine drag drop

* drag drop implemented (css tbd)

* phase 1 complete

* tbd work on summon action type

* Improved Schema and now it works

* .

* Dialog created. Tokens not dragged(tbd).

* Bare minimum implementation

* Finalized functionality

* Cleanup

* .

* Added optional summon render to chat message

* Updated SRD

* bugfix: fix title lines not rendering in chat messages

* Added summon actions to the easily doable environments in the SRD

* Update module/data/fields/action/summonField.mjs

Co-authored-by: Carlos Fernandez <CarlosFdez@users.noreply.github.com>

---------

Co-authored-by: Nikhil Nagarajan <potter.nikhil@gmail.com>
Co-authored-by: Murilo Brito <dev.murilobrito@gmail.com>
Co-authored-by: Carlos Fernandez <CarlosFdez@users.noreply.github.com>

module/data/fields/action/_module.mjs

@@ -9,3 +9,4 @@ export { default as BeastformField } from './beastformField.mjs';
 export { default as DamageField } from './damageField.mjs';
 export { default as RollField } from './rollField.mjs';
 export { default as MacroField } from './macroField.mjs';
+export { default as SummonField } from './summonField.mjs';

module/data/fields/action/summonField.mjs

@@ -0,0 +1,89 @@
+import FormulaField from '../formulaField.mjs';
+
+const fields = foundry.data.fields;
+
+export default class DHSummonField extends fields.ArrayField {
+    /**
+     * Action Workflow order
+     */
+    static order = 120;
+
+    constructor(options = {}, context = {}) {
+        const summonFields = new fields.SchemaField({
+            actorUUID: new fields.DocumentUUIDField({
+                type: 'Actor',
+                required: true
+            }),
+            count: new FormulaField({
+                required: true,
+                default: '1'
+            })
+        });
+        super(summonFields, options, context);
+    }
+
+    static async execute() {
+        if (!canvas.scene) {
+            ui.notifications.warn(game.i18n.localize('DAGGERHEART.ACTIONS.TYPES.summon.error'));
+            return;
+        }
+
+        if (this.summon.length === 0) {
+            ui.notifications.warn('No actors configured for this Summon action.');
+            return;
+        }
+
+        const rolls = [];
+        const summonData = [];
+        for (const summon of this.summon) {
+            let count = summon.count;
+            const roll = new Roll(summon.count);
+            if (!roll.isDeterministic) {
+                await roll.evaluate();
+                if (game.modules.get('dice-so-nice')?.active) rolls.push(roll);
+                count = roll.total;
+            }
+
+            const actor = DHSummonField.getWorldActor(await foundry.utils.fromUuid(summon.actorUUID));
+            /* Extending summon data in memory so it's available in actionField.toChat. Think it's harmless, but ugly. Could maybe find a better way. */
+            summon.rolledCount = count;
+            summon.actor = actor.toObject();
+
+            summonData.push({ actor, count: count });
+        }
+
+        if (rolls.length) await Promise.all(rolls.map(roll => game.dice3d.showForRoll(roll, game.user, true)));
+
+        this.actor.sheet?.minimize();
+        DHSummonField.handleSummon(summonData, this.actor);
+    }
+
+    /* Check for any available instances of the actor present in the world if we're missing artwork in the compendium */
+    static getWorldActor(baseActor) {
+        const dataType = game.system.api.data.actors[`Dh${baseActor.type.capitalize()}`];
+        if (baseActor.inCompendium && dataType && baseActor.img === dataType.DEFAULT_ICON) {
+            const worldActorCopy = game.actors.find(x => x.name === baseActor.name);
+            return worldActorCopy ?? baseActor;
+        }
+
+        return baseActor;
+    }
+
+    static async handleSummon(summonData, actionActor, summonIndex = 0) {
+        const summon = summonData[summonIndex];
+        const result = await CONFIG.ux.TokenManager.createPreviewAsync(summon.actor, {
+            name: `${summon.actor.prototypeToken.name}${summon.count > 1 ? ` (${summon.count}x)` : ''}`
+        });
+
+        if (!result) return actionActor.sheet?.maximize();
+        summon.actor = result.actor;
+
+        summon.count--;
+        if (summon.count <= 0) {
+            summonIndex++;
+            if (summonIndex === summonData.length) return actionActor.sheet?.maximize();
+        }
+
+        DHSummonField.handleSummon(summonData, actionActor, summonIndex);
+    }
+}

module/data/fields/actionField.mjs

@@ -267,7 +267,8 @@ export function ActionMixin(Base) {
                 action: {
                     name: this.name,
                     img: this.baseAction ? this.parent.parent.img : this.img,
-                    tags: this.tags ? this.tags : ['Spell', 'Arcana', 'Lv 10']
+                    tags: this.tags ? this.tags : ['Spell', 'Arcana', 'Lv 10'],
+                    summon: this.summon
                 },
                 itemOrigin: this.item,
                 description: this.description || (this.item instanceof Item ? this.item.system.description : '')