[#5559] Add activity behavior for Apply Active Effect behavior

icons/LICENSE

@@ -46,6 +46,7 @@ The dnd5e system for Foundry Virtual Tabletop includes icon artwork licensed fro
 /svg/actors/group.svg - "Tattered banner" by Lorc under CC BY 3.0
 /svg/actors/npc.svg - "Spiked dragon head" by Delapouite under CC BY 3.0
 /svg/actors/vehicle.svg - "Ship's wheel" by Delapouite under CC BY 3.0
+/svg/behaviors/apply-active-effect.svg - "Aura" by Lorc under CC BY 3.0
 /svg/behaviors/difficult-terrain.svg - "Falling rocks" by Delapouite under CC BY 3.0
 /svg/damage/acid.svg - "Fizzling flask" by Lorc under CC BY 3.0
 /svg/damage/all.svg - "Triple plier" by Lorc under CC BY 3.0

lang/en.json

@@ -3610,6 +3610,14 @@
 "DND5E.RecoveryFormula": "Recovery Formula",
 
 "DND5E.REGIONBEHAVIORS": {
+  "APPLYACTIVEEFFECT": {
+    "FIELDS": {
+      "effects": {
+        "hint": "The effects that are applied to Tokens within the area of effect.",
+        "label": "Effects"
+      }
+    }
+  },
   "DIFFICULTTERRAIN": {
     "FIELDS": {
       "ignoredDispositions": {

module/config.mjs

@@ -1099,6 +1099,11 @@ preLocalize("activityActivationTypes", { key: "label" });
  * @enum {ActivityBehaviorConfiguration}
  */
 DND5E.activityBehaviorTypes = {
+  appylActiveEffect: {
+    label: "TYPES.RegionBehavior.applyActiveEffect",
+    icon: "systems/dnd5e/icons/svg/behaviors/apply-active-effect.svg",
+    model: regionBehaviors.ApplyActiveEffectActivityBehavior
+  },
   difficultTerrain: {
     label: "TYPES.RegionBehavior.dnd5e.difficultTerrain",
     icon: "systems/dnd5e/icons/svg/behaviors/difficult-terrain.svg",

module/data/region-behavior/_module.mjs

@@ -6,6 +6,7 @@ export {
   DifficultTerrainRegionBehaviorType,
   RotateAreaRegionBehaviorType
 };
+export * from "./apply-active-effect.mjs";
 export {default as BaseActivityBehavior} from "./base-activity-behavior.mjs";
 
 export const config = {

module/data/region-behavior/_types.mjs

@@ -1,3 +1,10 @@
+/**
+ * @typedef ApplyActiveEffectActivityBehaviorData
+ * @property {Set<string>} effects  UUIDs of effects to apply.
+ */
+
+/* -------------------------------------------- */
+
 /**
  * @typedef DifficultTerrainRegionBehaviorSystemData
  * @property {boolean} magical                  This difficult terrain is caused by magic.

module/data/region-behavior/apply-active-effect.mjs

@@ -0,0 +1,42 @@
+import BaseActivityBehavior from "./base-activity-behavior.mjs";
+
+const { DocumentUUIDField, SetField } = foundry.data.fields;
+
+/**
+ * @import { ApplyActiveEffectActivityBehaviorData } from "./_types.mjs";
+ */
+
+/**
+ * Data model representing the difficult terrain activity behavior configuration.
+ * @extends {foundry.abstract.DataModel<ApplyActiveEffectActivityBehaviorData>}
+ * @mixes ApplyActiveEffectActivityBehaviorData
+ */
+export class ApplyActiveEffectActivityBehavior extends BaseActivityBehavior {
+
+  /** @override */
+  static LOCALIZATION_PREFIXES = ["DND5E.REGIONBEHAVIORS.APPLYACTIVEEFFECT"];
+
+  /* -------------------------------------------- */
+
+  /** @override */
+  static defineSchema() {
+    return {
+      effects: new SetField(new DocumentUUIDField())
+    };
+  }
+
+  /* -------------------------------------------- */
+  /*  Methods                                     */
+  /* -------------------------------------------- */
+
+  /** @override */
+  createBehaviorData(activity, options={}) {
+    return {
+      system: {
+        effects: this.effects
+      },
+      type: "applyActiveEffect"
+    };
+  }
+
+}