Add status effect integration

Author: DFreds

src/ts/app/convenient-effects-app.ts

@@ -341,6 +341,16 @@ class ConvenientEffectsApp extends Application {
                     this.#controller,
                 ),
             },
+            {
+                name: "ConvenientEffects.ToggleStatusEffect",
+                icon: '<i class="far fa-person-rays fa-fw"></i>',
+                condition: this.#controller.canToggleStatusEffect.bind(
+                    this.#controller,
+                ),
+                callback: this.#controller.onToggleStatusEffect.bind(
+                    this.#controller,
+                ),
+            },
             {
                 name: "SIDEBAR.Duplicate",
                 icon: '<i class="far fa-copy fa-fw"></i>',

src/ts/app/convenient-effects-controller.ts

@@ -11,12 +11,15 @@ import {
     findFolders,
     findAllNestedEffectIds,
     findEffectByCeId,
+    findModuleById,
 } from "../utils/finds.ts";
 import { getBaseType } from "../utils/gets.ts";
 import { log } from "../logger.ts";
 import { getInputFromDialog } from "../ui/create-edit-folder-dialog.ts";
 import { Flags } from "../utils/flags.ts";
 import { BackupConvenientEffectsApp } from "./backup/backup-convenient-effects-app.ts";
+import { MODULE_IDS } from "../constants.ts";
+import { StatusEffectsModule } from "../integrations/status-effect-types.ts";
 
 interface ViewData {
     folderData: FolderData[];
@@ -254,6 +257,42 @@ class ConvenientEffectsController {
         });
     }
 
+    canToggleStatusEffect(_target: JQuery<HTMLElement>): boolean {
+        return !!findModuleById(MODULE_IDS.STATUS_EFFECTS)?.active;
+    }
+
+    async onToggleStatusEffect(target: JQuery<HTMLElement>): Promise<void> {
+        const ceEffectId = this.#findClosestCeEffectIdByElement(target);
+        if (!ceEffectId) return;
+
+        const ceEffect = findEffectByCeId(ceEffectId);
+        if (!ceEffect) return;
+
+        const statusEffectsModule = findModuleById(
+            MODULE_IDS.STATUS_EFFECTS,
+        ) as StatusEffectsModule | undefined;
+        if (!statusEffectsModule?.active) return;
+
+        const statusEffectsApi = statusEffectsModule.api;
+        const statusEffect = statusEffectsApi.findStatusEffect({
+            effectId: ceEffectId,
+            effectName: ceEffect.name,
+        });
+
+        if (statusEffect) {
+            await statusEffectsApi.deleteStatusEffect({
+                effectId: ceEffectId,
+                effectName: ceEffect.name,
+            });
+        } else {
+            await statusEffectsApi.createNewStatusEffects({
+                effectsData: [ceEffect.toObject()],
+            });
+        }
+
+        this.#viewMvc.render();
+    }
+
     onViewBackups(_event: Event): void {
         new BackupConvenientEffectsApp().render(true);
     }

src/ts/constants.ts

@@ -14,6 +14,7 @@ export const MODULE_IDS = {
     ATE: "ATL",
     MIDI: "midi-qol",
     TOKEN_MAGIC: "tokenmagic",
+    STATUS_EFFECTS: "dfreds-status-effects",
 };
 
 export const SECONDS = {

src/ts/integrations/status-effect-types.ts

@@ -0,0 +1,51 @@
+import { ActiveEffectSource } from "types/foundry/common/documents/active-effect.js";
+
+interface StatusEffectsModule extends Module {
+    api: StatusEffectsApi;
+}
+
+interface IFindStatusEffect {
+    /**
+     * The foundry effect ID or the SE effect ID
+     */
+    effectId?: string | null;
+
+    /**
+     * The effect name
+     */
+    effectName?: string | null;
+}
+
+interface ICreateNewStatusEffects {
+    /**
+     * The data that defines the status effects to create
+     */
+    effectsData: PreCreate<ActiveEffectSource>[];
+}
+
+interface IDeleteStatusEffect {
+    /**
+     * The foundry effect ID or the SE effect ID to remove. If defined,
+     * prioritized over `effectName`
+     */
+    effectId?: string;
+
+    /**
+     * The name of the effect to remove
+     */
+    effectName?: string;
+}
+
+interface StatusEffectsApi {
+    findStatusEffects(): ActiveEffect<Item<any>>[];
+
+    findStatusEffect(
+        input: IFindStatusEffect,
+    ): ActiveEffect<Item<null>> | undefined;
+
+    createNewStatusEffects(input: ICreateNewStatusEffects): Promise<Document[]>;
+
+    deleteStatusEffect(input: IDeleteStatusEffect): Promise<void>;
+}
+
+export type { StatusEffectsModule, StatusEffectsApi };

src/ts/ui/handlebar-helpers.ts

@@ -4,6 +4,7 @@ import { Flags } from "../utils/flags.ts";
 import { notEmpty } from "../utils/types.ts";
 import { findAllNestedEffectIds, findModuleById } from "../utils/finds.ts";
 import { MODULE_IDS } from "../constants.ts";
+import { StatusEffectsModule } from "../integrations/status-effect-types.ts";
 
 class HandlebarHelpers {
     #settings: Settings;
@@ -120,6 +121,10 @@ class HandlebarHelpers {
                     findAllNestedEffectIds({ backup: false }),
                 );
 
+                if (findModuleById(MODULE_IDS.STATUS_EFFECTS)?.active) {
+                    icons += this.#getStatusEffectsIcon(effect);
+                }
+
                 if (findModuleById(MODULE_IDS.MIDI)?.active) {
                     icons += this.#getMidiIcon(allChanges);
                 }
@@ -179,6 +184,22 @@ class HandlebarHelpers {
             : "";
     }
 
+    #getStatusEffectsIcon(effect: ActiveEffect<Item<null>>): string {
+        const statusEffectsModule = findModuleById(
+            MODULE_IDS.STATUS_EFFECTS,
+        ) as StatusEffectsModule | undefined;
+
+        const statusEffectsApi = statusEffectsModule?.api;
+        const statusEffect = statusEffectsApi?.findStatusEffect({
+            effectId: Flags.getCeEffectId(effect),
+            effectName: effect.name,
+        });
+
+        return statusEffect
+            ? "<i class='fas fa-person-rays integration-icon' title='Status Effect'></i>"
+            : "";
+    }
+
     #getMidiIcon(changes: DeepPartial<EffectChangeData>[]): string {
         return changes.some((change) =>
             change.key?.startsWith("flags.midi-qol"),

static/lang/en.json

@@ -32,6 +32,7 @@
         "ShowEffect": "Show Effect",
         "HideEffect": "Hide Effect",
         "ToggleAsOverlay": "Toggle as Overlay",
+        "ToggleStatusEffect": "Toggle Status Effect",
         "ResetSystemEffects": "Reset System Effects",
         "ResetSystemEffectsWarning": "This will completely reset to the built-in effects, undoing any custom creations, deletions, or edits that were made.",