[#5559, #6722] Add Activity Behaviors that attach to templates

Adds a new system for registering Activity Behaviors. These will
be automatically attached to any measured templates created from
that activity. An Activity Behavior represents a simplified data
model for configuring a Region Behavior, allowing for certain
parts of the Region Behavior's configuration to be automatically
populated based on activity settings (for example, the Difficult
Terrain behavior gets its "Magical" property set automatically
based on whether the item has the magical property set).

Since players cannot create region behaviors themselves, the
creation of these behaviors is handled by the active GM user after
the player places the template in the scene.

Closes #6722

Author: arbron

dnd5e.mjs

@@ -534,6 +534,7 @@ Hooks.once("i18nInit", () => {
   }
   utils.performPreLocalization(CONFIG.DND5E);
   Object.values(CONFIG.DND5E.activityTypes).forEach(c => c.documentClass.localize());
+  Object.values(CONFIG.DND5E.activityBehaviorTypes).forEach(c => c.model.localize());
   Object.values(CONFIG.DND5E.advancementTypes).forEach(c => c.documentClass.localize());
   foundry.helpers.Localization.localizeDataModel(dataModels.settings.CalendarConfigSetting);
   foundry.helpers.Localization.localizeDataModel(dataModels.settings.CalendarPreferencesSetting);
@@ -634,6 +635,8 @@ Hooks.on("chatMessage", (app, message, data) => applications.Award.chatMessage(m
 Hooks.on("createChatMessage", dataModels.chatMessage.RequestMessageData.onCreateMessage);
 Hooks.on("updateChatMessage", dataModels.chatMessage.RequestMessageData.onUpdateResultMessage);
 
+Hooks.on("createRegion", documents.activity.UtilityActivity.placeTemplateBehaviors);
+
 Hooks.on("renderActorDirectory", (app, html, data) => documents.Actor5e.onRenderActorDirectory(html));
 
 Hooks.on("getActorContextOptions", documents.Actor5e.addDirectoryContextOptions);

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/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
 /svg/damage/bludgeoning.svg - "Claw hammer" by Lorc under CC BY 3.0

icons/svg/behaviors/difficult-terrain.svg

@@ -276,6 +276,24 @@
     "other": "Activities"
   },
   "FIELDS": {
+    "behaviors": {
+      "element": {
+        "level": {
+          "label": "Level Limit",
+          "hint": "Range of levels required to apply this behavior.",
+          "max": {
+            "label": "Maximum Level"
+          },
+          "min": {
+            "label": "Minimum Level"
+          }
+        },
+        "name": {
+          "label": "Name"
+        }
+      },
+      "label": "Applied Behaviors"
+    },
     "description": {
       "label": "Description",
       "chatFlavor": {
@@ -1056,6 +1074,15 @@
   }
 },
 
+"DND5E.BEHAVIOR": {
+  "Action": {
+    "Create": "Create Behavior",
+    "Delete": "Delete Behavior"
+  },
+  "Hint": "These behaviors will apply to any area of effect placed by this activity.",
+  "Label": "Behavior"
+},
+
 "DND5E.Biography": "Biography",
 "DND5E.BiographyPublic": "Public Biography",
 "DND5E.BiopgrahyPublicEdit": "Edit Public Biography",

lang/en.json

@@ -47,6 +47,14 @@
 
 /* -------------------------------------------- */
 
+/**
+ * @typedef ActivityBehaviorConfiguration
+ * @param {string} label  Localized label for the behavior.
+ * @param {string} icon   Icon representing the behavior.
+ */
+
+/* -------------------------------------------- */
+
 /**
  * @typedef ActivityConsumptionTargetConfiguration
  * @property {string} label                                     Localized label for the target type.

module/_types.mjs

@@ -1,4 +1,6 @@
+import CreateDocumentDialog from "../create-document-dialog.mjs";
 import { ConsumptionTargetData } from "../../data/activity/fields/consumption-targets-field.mjs";
+import BaseActivityBehavior from "../../data/region-behavior/base-activity-behavior.mjs";
 import UsesField from "../../data/shared/uses-field.mjs";
 import PseudoDocumentSheet from "../api/pseudo-document-sheet.mjs";
 
@@ -13,10 +15,12 @@ export default class ActivitySheet extends PseudoDocumentSheet {
       icon: "fa-solid fa-gauge"
     },
     actions: {
+      addBehavior: ActivitySheet.#addBehavior,
       addConsumption: ActivitySheet.#addConsumption,
       addDamagePart: ActivitySheet.#addDamagePart,
       addEffect: ActivitySheet.#addEffect,
       addRecovery: ActivitySheet.#addRecovery,
+      deleteBehavior: ActivitySheet.#deleteBehavior,
       deleteConsumption: ActivitySheet.#deleteConsumption,
       deleteDamagePart: ActivitySheet.#deleteDamagePart,
       deleteEffect: ActivitySheet.#deleteEffect,
@@ -54,6 +58,9 @@ export default class ActivitySheet extends PseudoDocumentSheet {
     effect: {
       template: "systems/dnd5e/templates/activity/effect.hbs",
       templates: [
+        "systems/dnd5e/templates/activity/parts/activity-behaviors.hbs",
+        "systems/dnd5e/templates/activity/parts/activity-behavior-level-limit.hbs",
+        "systems/dnd5e/templates/activity/parts/activity-behavior-settings.hbs",
         "systems/dnd5e/templates/activity/parts/activity-effects.hbs",
         "systems/dnd5e/templates/activity/parts/activity-effect-level-limit.hbs",
         "systems/dnd5e/templates/activity/parts/activity-effect-settings.hbs"
@@ -230,6 +237,19 @@ export default class ActivitySheet extends PseudoDocumentSheet {
 
   /* -------------------------------------------- */
 
+  /**
+   * Prepare a specific applied behavior if present in the activity data.
+   * @param {ApplicationRenderContext} context  Context being prepared.
+   * @param {object} behavior                   Applied behavior context being prepared.
+   * @returns {object}
+   * @protected
+   */
+  _prepareAppliedBehaviorContext(context, behavior) {
+    return behavior;
+  }
+
+  /* -------------------------------------------- */
+
   /**
    * Prepare a specific applied effect if present in the activity data.
    * @param {ApplicationRenderContext} context  Context being prepared.
@@ -266,6 +286,26 @@ export default class ActivitySheet extends PseudoDocumentSheet {
   async _prepareEffectContext(context, options) {
     context.tab = context.tabs.effect;
 
+    if ( context.activity.behaviors && (context.activity.target?.template?.type || this.activity.isRider) ) {
+      context.appliedBehaviors = context.activity.behaviors.values()
+        .filter(d => d.type in CONFIG.DND5E.activityBehaviorTypes)
+        .map(data => {
+          const source = context.source.behaviors[data._index];
+          if ( !source ) return null;
+          const instance = new CONFIG.DND5E.activityBehaviorTypes[source.type].model(source.config);
+          const ctx = {
+            data, source,
+            additionalFields: instance.generateFields(source.config, { prefix: `behaviors.${data._index}.config.` }),
+            additionalSettings: "systems/dnd5e/templates/activity/parts/activity-behavior-settings.hbs",
+            collapsed: this.expandedSections.get(`behavior.${data._id}`) ? "" : "collapsed",
+            config: CONFIG.DND5E.activityBehaviorTypes[data.type],
+            fields: this.activity.schema.fields.behaviors.element.fields,
+            prefix: `behaviors.${data._index}.`
+          };
+          return this._prepareAppliedBehaviorContext(context, ctx);
+        });
+    }
+
     if ( context.activity.effects ) {
       const appliedEffects = new Set(context.activity.effects?.map(e => e._id) ?? []);
       context.allEffects = this.item.effects
@@ -462,6 +502,21 @@ export default class ActivitySheet extends PseudoDocumentSheet {
 
   /* -------------------------------------------- */
 
+  /**
+   * Handle adding a new entry to the behaviors list.
+   * @this {ActivitySheet}
+   * @param {Event} event         Triggering click event.
+   * @param {HTMLElement} target  Button that was clicked.
+   */
+  static async #addBehavior(event, target) {
+    if ( !this.activity.behaviors ) return;
+    const createData = await CreateDocumentDialog.prompt(BaseActivityBehavior, {}, { parent: this.activity });
+    if ( !createData?.type ) return;
+    this.activity.update({ behaviors: [...this.activity.toObject().behaviors, createData] });
+  }
+
+  /* -------------------------------------------- */
+
   /**
    * Handle adding a new entry to the consumption list.
    * @this {ActivitySheet}
@@ -551,6 +606,20 @@ export default class ActivitySheet extends PseudoDocumentSheet {
 
   /* -------------------------------------------- */
 
+  /**
+   * Handle removing an entry from the behaviors list.
+   * @this {ActivitySheet}
+   * @param {Event} event         Triggering click event.
+   * @param {HTMLElement} target  Button that was clicked.
+   */
+  static #deleteBehavior(event, target) {
+    if ( !this.activity.behaviors ) return;
+    const behaviors = this.activity.toObject().behaviors;
+    this.activity.update({ behaviors: behaviors.toSpliced(target.closest("[data-index]").dataset.index, 1) });
+  }
+
+  /* -------------------------------------------- */
+
   /**
    * Handle removing an entry from the consumption targets list.
    * @this {ActivitySheet}

module/applications/activity/activity-sheet.mjs

@@ -92,8 +92,6 @@ export default class CreateDocumentDialog extends Dialog5e {
       if ( this.options.types?.length === 0 ) throw new Error("The array of sub-types to restrict to must not be empty");
 
       for ( const type of TYPES ) {
-        // TODO: When `standard` AE type replaces `base`, remove this check for active effect
-        // See https://github.com/foundryvtt/dnd5e/pull/5941
         if ( (this.documentName !== "ActiveEffect") && (type === CONST.BASE_DOCUMENT_TYPE) ) continue;
         if ( this.options.types && !this.options.types.includes(type) ) continue;
         const typeData = { selected: type === defaultType, type };
@@ -112,6 +110,8 @@ export default class CreateDocumentDialog extends Dialog5e {
 
       context.types.sort((a, b) => a.label.localeCompare(b.label, game.i18n.lang));
       context.hasTypes = true;
+    } else if ( (TYPES?.length === 1) && !this.options.createData.type ) {
+      this.options.createData.type = defaultType ?? TYPES[0];
     }
 
     return context;
@@ -159,7 +159,7 @@ export default class CreateDocumentDialog extends Dialog5e {
    * @param {DatabaseCreateOperation} [createOptions={}]          Document creation options.
    * @param {object} [dialogOptions={}]                           Options forwarded to dialog.
    * @param {object} [dialogOptions.ok={}]                        Options for the OK button.
-   * @returns {Promise<Document>}
+   * @returns {Promise<Document|PseudoDocument|object|void>}
    */
   static async prompt(documentType, data={}, { folders, types, ...createOptions }={}, { ok={}, ...config }={}) {
     const label = game.i18n.localize(documentType.metadata.label ?? `DOCUMENT.DND5E.${documentType.documentName}`);
@@ -190,8 +190,10 @@ export default class CreateDocumentDialog extends Dialog5e {
       createOptions.renderSheet ??= true;
       if ( foundry.utils.isSubclass(documentType, foundry.abstract.Document) ) {
         resolve(documentType.create(createData, createOptions));
-      } else {
+      } else if ( createOptions.parent?.[`create${documentType.documentName}`] ) {
         resolve(createOptions.parent[`create${documentType.documentName}`](createData.type, createData, createOptions));
+      } else {
+        resolve(createData);
       }
     });
     dialog.render({ force: true });

module/applications/create-document-dialog.mjs

@@ -4,6 +4,7 @@ import { ConsumptionTargetData } from "./data/activity/fields/consumption-target
 import { CalendarGreyhawk, CALENDAR_OF_GREYHAWK } from "./data/calendar/calendar-of-greyhawk.mjs";
 import { CalendarHarptos, CALENDAR_OF_HARPTOS } from "./data/calendar/calendar-of-harptos.mjs";
 import { CalendarKhorvaire, CALENDAR_OF_KHORVAIRE } from "./data/calendar/calendar-of-khorvaire.mjs";
+import * as regionBehaviors from "./data/region-behavior/_module.mjs";
 import * as activities from "./documents/activity/_module.mjs";
 import Actor5e from "./documents/actor/actor.mjs";
 import * as advancement from "./documents/advancement/_module.mjs";
@@ -1093,6 +1094,21 @@ preLocalize("activityActivationTypes", { key: "label" });
 
 /* -------------------------------------------- */
 
+/**
+ * Types of behaviors that can be attached to regions through activities.
+ * @enum {ActivityBehaviorConfiguration}
+ */
+DND5E.activityBehaviorTypes = {
+  difficultTerrain: {
+    label: "TYPES.RegionBehavior.dnd5e.difficultTerrain",
+    icon: "systems/dnd5e/icons/svg/behaviors/difficult-terrain.svg",
+    model: regionBehaviors.DifficultTerrainActivityBehavior
+  }
+};
+preLocalize("activityBehaviorTypes", { key: "label" });
+
+/* -------------------------------------------- */
+
 /**
  * Different things that an ability can consume upon use.
  * @enum {string}

module/config.mjs

@@ -12,6 +12,7 @@ export {default as SummonActivityData} from "./summon-data.mjs";
 export {default as TransformActivityData} from "./transform-data.mjs";
 export {default as UtilityActivityData} from "./utility-data.mjs";
 
+export {default as AppliedBehaviorField} from "./fields/applied-behavior-field.mjs";
 export {default as AppliedEffectField} from "./fields/applied-effect-field.mjs";
 export {
   default as ConsumptionTargetsField, ConsumptionTargetData, ConsumptionError