[Feature] 1541 - Trigger Improvements (#1542)

* Improved registration and unregistration of triggers

* Added logging

* Fixed Feature level unregistration

* Fixed action deletion unregistration

* SceneEnvironment stub

* Update module/data/registeredTriggers.mjs

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

---------

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

daggerheart.mjs

@@ -78,6 +78,7 @@ CONFIG.ux.ContextMenu = applications.ux.DHContextMenu;
 CONFIG.ux.TooltipManager = documents.DhTooltipManager;
 CONFIG.ux.TemplateManager = new TemplateManager();
 CONFIG.ux.TokenManager = new TokenManager();
+CONFIG.debug.triggers = false;
 
 Hooks.once('init', () => {
     game.system.api = {
@@ -89,7 +90,7 @@ Hooks.once('init', () => {
         fields
     };
 
-    game.system.registeredTriggers = new RegisteredTriggers();
+    game.system.registeredTriggers = new game.system.api.data.RegisteredTriggers();
 
     const { DocumentSheetConfig } = foundry.applications.apps;
     DocumentSheetConfig.unregisterSheet(TokenDocument, 'core', foundry.applications.sheets.TokenConfig);
@@ -389,49 +390,12 @@ Hooks.on('refreshToken', (_, options) => {
 Hooks.on('renderCompendiumDirectory', (app, html) => applications.ui.ItemBrowser.injectSidebarButton(html));
 Hooks.on('renderDocumentDirectory', (app, html) => applications.ui.ItemBrowser.injectSidebarButton(html));
 
-class RegisteredTriggers extends Map {
-    constructor() {
-        super();
-    }
+/* Non actor-linked Actors should unregister the triggers of their tokens if a scene's token layer is torn down */
+Hooks.on('canvasTearDown', canvas => {
+    game.system.registeredTriggers.unregisterSceneTriggers(canvas.scene);
+});
 
-    async registerTriggers(trigger, actor, triggeringActorType, uuid, commands) {
-        const existingTrigger = this.get(trigger);
-        if (!existingTrigger) this.set(trigger, new Map());
-
-        this.get(trigger).set(uuid, { actor, triggeringActorType, commands });
-    }
-
-    async runTrigger(trigger, currentActor, ...args) {
-        const updates = [];
-        const triggerSettings = game.settings.get(CONFIG.DH.id, CONFIG.DH.SETTINGS.gameSettings.Automation).triggers;
-        if (!triggerSettings.enabled) return updates;
-
-        const dualityTrigger = this.get(trigger);
-        if (dualityTrigger) {
-            for (let { actor, triggeringActorType, commands } of dualityTrigger.values()) {
-                const triggerData = CONFIG.DH.TRIGGER.triggers[trigger];
-                if (triggerData.usesActor && triggeringActorType !== 'any') {
-                    if (triggeringActorType === 'self' && currentActor?.uuid !== actor) continue;
-                    else if (triggeringActorType === 'other' && currentActor?.uuid === actor) continue;
-                }
-
-                for (let command of commands) {
-                    try {
-                        const result = await command(...args);
-                        if (result?.updates?.length) updates.push(...result.updates);
-                    } catch (_) {
-                        const triggerName = game.i18n.localize(triggerData.label);
-                        ui.notifications.error(
-                            game.i18n.format('DAGGERHEART.CONFIG.Triggers.triggerError', {
-                                trigger: triggerName,
-                                actor: currentActor?.name
-                            })
-                        );
-                    }
-                }
-            }
-        }
-
-        return updates;
-    }
-}
+/* Non actor-linked Actors should register the triggers of their tokens on a readied scene */
+Hooks.on('canvasReady', canas => {
+    game.system.registeredTriggers.registerSceneTriggers(canvas.scene);
+});

lang/en.json

@@ -2710,6 +2710,9 @@
                 "rerollDamage": "Reroll Damage",
                 "assignTagRoll": "Assign as Tag Roll"
             },
+            "ConsoleLogs": {
+                "triggerRun": "DH TRIGGER | Item '{item}' on actor '{actor}' ran a '{trigger}' trigger."
+            },
             "Countdowns": {
                 "title": "Countdowns",
                 "toggleIconMode": "Toggle Icon Only",

module/data/_module.mjs

@@ -1,6 +1,7 @@
 export { default as DhCombat } from './combat.mjs';
 export { default as DhCombatant } from './combatant.mjs';
 export { default as DhTagTeamRoll } from './tagTeamRoll.mjs';
+export { default as RegisteredTriggers } from './registeredTriggers.mjs';
 
 export * as countdowns from './countdowns.mjs';
 export * as actions from './action/_module.mjs';

module/data/item/base.mjs

@@ -164,26 +164,7 @@ export default class BaseDataItem extends foundry.abstract.TypeDataModel {
 
     prepareBaseData() {
         super.prepareBaseData();
-
-        for (const action of this.actions ?? []) {
-            if (!action.actor) continue;
-
-            const actionsToRegister = [];
-            for (let i = 0; i < action.triggers.length; i++) {
-                const trigger = action.triggers[i];
-                const { args } = CONFIG.DH.TRIGGER.triggers[trigger.trigger];
-                const fn = new foundry.utils.AsyncFunction(...args, `{${trigger.command}\n}`);
-                actionsToRegister.push(fn.bind(action));
-                if (i === action.triggers.length - 1)
-                    game.system.registeredTriggers.registerTriggers(
-                        trigger.trigger,
-                        action.actor?.uuid,
-                        trigger.triggeringActorType,
-                        this.parent.uuid,
-                        actionsToRegister
-                    );
-            }
-        }
+        game.system.registeredTriggers.registerItemTriggers(this.parent);
     }
 
     async _preCreate(data, options, user) {
@@ -246,6 +227,28 @@ export default class BaseDataItem extends foundry.abstract.TypeDataModel {
             const armorData = getScrollTextData(this.parent.parent.system.resources, changed.system.marks, 'armor');
             options.scrollingTextData = [armorData];
         }
+
+        if (changed.system?.actions) {
+            const triggersToRemove = Object.keys(changed.system.actions).reduce((acc, key) => {
+                if (!changed.system.actions[key]) {
+                    const strippedKey = key.replace('-=', '');
+                    acc.push(...this.actions.get(strippedKey).triggers.map(x => x.trigger));
+                }
+
+                return acc;
+            }, []);
+
+            game.system.registeredTriggers.unregisterTriggers(triggersToRemove, this.parent.uuid);
+
+            if (!(this.parent.parent.token instanceof game.system.api.documents.DhToken)) {
+                for (const token of this.parent.parent.getActiveTokens()) {
+                    game.system.registeredTriggers.unregisterTriggers(
+                        triggersToRemove,
+                        `${token.document.uuid}.${this.parent.uuid}`
+                    );
+                }
+            }
+        }
     }
 
     _onUpdate(changed, options, userId) {

module/data/registeredTriggers.mjs

@@ -0,0 +1,154 @@
+export default class RegisteredTriggers extends Map {
+    constructor() {
+        super();
+    }
+
+    registerTriggers(triggers, actor, uuid) {
+        for (const triggerKey of Object.keys(CONFIG.DH.TRIGGER.triggers)) {
+            const match = triggers[triggerKey];
+            const existingTrigger = this.get(triggerKey);
+
+            if (!match) {
+                if (existingTrigger?.get(uuid)) this.get(triggerKey).delete(uuid);
+            } else {
+                const { trigger, triggeringActorType, commands } = match;
+
+                if (!existingTrigger) this.set(trigger, new Map());
+                this.get(trigger).set(uuid, { actor, triggeringActorType, commands });
+            }
+        }
+    }
+
+    registerItemTriggers(item, registerOverride) {
+        for (const action of item.system.actions ?? []) {
+            if (!action.actor) continue;
+
+            /* Non actor-linked should only prep synthetic actors so they're not registering triggers unless they're on the canvas */
+            if (
+                !registerOverride &&
+                !action.actor.prototypeToken.actorLink &&
+                (!(action.actor.parent instanceof game.system.api.documents.DhToken) || !action.actor.parent?.uuid)
+            )
+                continue;
+
+            const triggers = {};
+            for (const trigger of action.triggers) {
+                const { args } = CONFIG.DH.TRIGGER.triggers[trigger.trigger];
+                const fn = new foundry.utils.AsyncFunction(...args, `{${trigger.command}\n}`);
+
+                if (!triggers[trigger.trigger])
+                    triggers[trigger.trigger] = {
+                        trigger: trigger.trigger,
+                        triggeringActorType: trigger.triggeringActorType,
+                        commands: []
+                    };
+                triggers[trigger.trigger].commands.push(fn.bind(action));
+            }
+
+            this.registerTriggers(triggers, action.actor?.uuid, item.uuid);
+        }
+    }
+
+    unregisterTriggers(triggerKeys, uuid) {
+        for (const triggerKey of triggerKeys) {
+            const existingTrigger = this.get(triggerKey);
+            if (!existingTrigger) return;
+
+            existingTrigger.delete(uuid);
+        }
+    }
+
+    unregisterItemTriggers(items) {
+        for (const item of items) {
+            if (!item.system.actions.size) continue;
+
+            const triggers = (item.system.actions ?? []).reduce((acc, action) => {
+                acc.push(...action.triggers.map(x => x.trigger));
+                return acc;
+            }, []);
+
+            this.unregisterTriggers(triggers, item.uuid);
+        }
+    }
+
+    unregisterSceneTriggers(scene) {
+        for (const triggerKey of Object.keys(CONFIG.DH.TRIGGER.triggers)) {
+            const existingTrigger = this.get(triggerKey);
+            if (!existingTrigger) continue;
+            const filtered = new Map();
+            for (const [uuid, data] of existingTrigger.entries()) {
+                if (!uuid.startsWith(scene.uuid)) filtered.set(uuid, data);
+            }
+            this.set(triggerKey, filtered);
+        }
+    }
+
+    registerSceneTriggers(scene) {
+        /* TODO: Finish sceneEnvironment registration and unreg */
+        // const systemData = new game.system.api.data.scenes.DHScene(scene.flags.daggerheart);
+        // for (const environment of systemData.sceneEnvironments) {
+        //     for (const feature of environment.system.features) {
+        //         if(feature) this.registerItemTriggers(feature, true);
+        //     }
+        // }
+
+        for (const actor of scene.tokens.filter(x => x.actor).map(x => x.actor)) {
+            if (actor.prototypeToken.actorLink) continue;
+
+            for (const item of actor.items) {
+                this.registerItemTriggers(item);
+            }
+        }
+    }
+
+    async runTrigger(trigger, currentActor, ...args) {
+        const updates = [];
+        const triggerSettings = game.settings.get(CONFIG.DH.id, CONFIG.DH.SETTINGS.gameSettings.Automation).triggers;
+        if (!triggerSettings.enabled) return updates;
+
+        const dualityTrigger = this.get(trigger);
+        if (dualityTrigger) {
+            const tokenBoundActors = ['adversary', 'environment'];
+            const triggerActors = ['character', ...tokenBoundActors];
+            for (let [itemUuid, { actor: actorUuid, triggeringActorType, commands }] of dualityTrigger.entries()) {
+                const actor = await foundry.utils.fromUuid(actorUuid);
+                if (!actor || !triggerActors.includes(actor.type)) continue;
+                if (tokenBoundActors.includes(actor.type) && !actor.getActiveTokens().length) continue;
+
+                const triggerData = CONFIG.DH.TRIGGER.triggers[trigger];
+                if (triggerData.usesActor && triggeringActorType !== 'any') {
+                    if (triggeringActorType === 'self' && currentActor?.uuid !== actorUuid) continue;
+                    else if (triggeringActorType === 'other' && currentActor?.uuid === actorUuid) continue;
+                }
+
+                for (const command of commands) {
+                    try {
+                        if (CONFIG.debug.triggers) {
+                            const item = await foundry.utils.fromUuid(itemUuid);
+                            console.log(
+                                game.i18n.format('DAGGERHEART.UI.ConsoleLogs.triggerRun', {
+                                    actor: actor.name ?? '<Missing Actor>',
+                                    item: item?.name ?? '<Missing Item>',
+                                    trigger: game.i18n.localize(triggerData.label)
+                                })
+                            );
+                        }
+
+                        const result = await command(...args);
+                        if (result?.updates?.length) updates.push(...result.updates);
+                    } catch (_) {
+                        const triggerName = game.i18n.localize(triggerData.label);
+                        ui.notifications.error(
+                            game.i18n.format('DAGGERHEART.CONFIG.Triggers.triggerError', {
+                                trigger: triggerName,
+                                actor: currentActor?.name
+                            })
+                        );
+                    }
+                }
+            }
+        }
+
+        return updates;
+    }
+}

module/documents/actor.mjs

@@ -104,6 +104,16 @@ export default class DhpActor extends Actor {
         }
     }
 
+    async _preDelete() {
+        if (this.prototypeToken.actorLink) {
+            game.system.registeredTriggers.unregisterItemTriggers(this.items);
+        } else {
+            for (const token of this.getActiveTokens()) {
+                game.system.registeredTriggers.unregisterItemTriggers(token.actor.items);
+            }
+        }
+    }
+
     _onDelete(options, userId) {
         super._onDelete(options, userId);
         for (const party of this.parties) {

module/documents/item.mjs

@@ -208,4 +208,23 @@ export default class DHItem extends foundry.documents.Item {
 
         cls.create(msg);
     }
+
+    deleteTriggers() {
+        const actions = Array.from(this.system.actions ?? []);
+        if (!actions.length) return;
+
+        const triggerKeys = actions.flatMap(action => action.triggers.map(x => x.trigger));
+
+        game.system.registeredTriggers.unregisterTriggers(triggerKeys, this.uuid);
+
+        if (!(this.actor.parent instanceof game.system.api.documents.DhToken)) {
+            for (const token of this.actor.getActiveTokens()) {
+                game.system.registeredTriggers.unregisterTriggers(triggerKeys, `${token.document.uuid}.${this.uuid}`);
+            }
+        }
+    }
+
+    async _preDelete() {
+        this.deleteTriggers();
+    }
 }

module/documents/token.mjs

@@ -536,4 +536,10 @@ export default class DHToken extends CONFIG.Token.documentClass {
         };
     }
     //#endregion
+
+    async _preDelete() {
+        if (this.actor && !this.actor.prototypeToken?.actorLink) {
+            game.system.registeredTriggers.unregisterItemTriggers(this.actor.items);
+        }
+    }
 }