[#6261] Add modifiers to DamageData

Adds a new modifiers field for damage that is applied automatically
to the formula. The `DamageData` model now automatically adds these
modifiers to the formula, attaching to the first roll (if one can
be found when using a custom formula).

The `DamageData#scaledFormula` supports passing in additional
modifiers that are also appended. This is to support a future Rule
active effect that adds modifiers to certain rolls at evaluation
time (such as Elemental Adept, which would add `min2` to all damage
rolls from spells that deal a certain damage type).

Closes #6261

Author: arbron

lang/en.json

@@ -2077,6 +2077,10 @@
             "label": "Die Denomination",
             "hint": "Denomination of the dice to roll."
           },
+          "modifiers": {
+            "label": "Modifiers",
+            "hint": "Roll modifiers added to the base die."
+          },
           "number": {
             "label": "Die Number",
             "hint": "Number of dice to roll."
@@ -3800,6 +3804,7 @@
 },
 "DND5E.RollExample": "e.g. 1d4",
 "DND5E.RollMode": "Roll Mode",
+"DND5E.RollModifiers": "Modifiers",
 "DND5E.RollSituationalBonus": "Situational Bonus?",
 "DND5E.Rule": {
   "Tooltip": "Tooltip",

less/v2/forms.less

@@ -335,9 +335,12 @@
       &.multi-select {
         position: relative;
 
-        multi-select .tags.input-element-tags {
-          min-height: 10px;
-          padding-left: 40%;
+        :is(multi-select, string-tags) {
+          &:has(.input-element-tags:empty) { margin-block-start: 8px; }
+          .tags.input-element-tags {
+            min-height: 10px;
+            padding-left: 40%;
+          }
         }
 
         > label {
@@ -506,7 +509,7 @@
     &:not(:disabled) { cursor: var(--cursor-pointer); }
   }
 
-  :is(document-tags, multi-select) .tags.input-element-tags .tag {
+  :is(document-tags, multi-select, string-tags) .tags.input-element-tags .tag {
     cursor: var(--cursor-pointer);
     font-size: var(--font-size-10);
     border: var(--dnd5e-border-gold);
@@ -516,7 +519,7 @@
     &:hover a { text-shadow: 0 0 6px var(--color-shadow-primary); }
   }
 
-  :is(document-tags, multi-select):has(select:disabled) .tags.input-element-tags .tag {
+  :is(document-tags, multi-select, string-tags):has(select:disabled) .tags.input-element-tags .tag {
     cursor: var(--cursor-default);
     a { cursor: var(--cursor-default); }
     &:hover a { text-shadow: none; }
@@ -526,7 +529,7 @@
 
   multi-select.hidden-tags .tags.input-element-tags { display: none; }
 
-  :is(file-picker, document-tags) > button {
+  :is(file-picker, document-tags, string-tags) > button {
     height: var(--form-field-height);
     border: var(--dnd5e-border-gold);
   }
@@ -712,7 +715,7 @@
     &:not(.copy-button, .unbutton, .reveal) { line-height: 28px; }
   }
 
-  :is(document-tags, multi-select) .tags.input-element-tags .tag {
+  :is(document-tags, multi-select, string-tags) .tags.input-element-tags .tag {
     padding: 1px 4px;
     color: var(--color-text-primary);
     height: unset;

module/data/shared/_types.mjs

@@ -32,6 +32,7 @@
  * @property {object} custom
  * @property {boolean} custom.enabled  Should the custom formula be used?
  * @property {string} custom.formula   Custom damage formula.
+ * @property {Set<string>} modifiers   Modifiers to apply to damage roll.
  * @property {object} scaling
  * @property {string} scaling.mode     How the damage scales in relation with levels.
  * @property {number} scaling.number   Number of dice to add per scaling level.

module/data/shared/damage-field.mjs

@@ -34,6 +34,7 @@ export class DamageData extends foundry.abstract.DataModel {
         enabled: new BooleanField(),
         formula: new FormulaField()
       }),
+      modifiers: new SetField(new StringField()),
       scaling: new SchemaField({
         mode: new StringField(),
         number: new NumberField({ initial: 1, min: 0, integer: true }),
@@ -51,7 +52,7 @@ export class DamageData extends foundry.abstract.DataModel {
    * @type {string}
    */
   get formula() {
-    if ( this.custom.enabled ) return this.custom.formula ?? "";
+    if ( this.custom.enabled ) return this._manualFormula();
     return this._automaticFormula();
   }
 
@@ -60,44 +61,65 @@ export class DamageData extends foundry.abstract.DataModel {
   /* -------------------------------------------- */
 
   /**
-   * Produce the auto-generated formula from the `number`, `denomination`, and `bonus`.
-   * @param {number} [increase=0]  Amount to increase the die count.
+   * Produce the auto-generated formula from the `number`, `denomination`, `modifiers`, and `bonus`.
+   * @param {number} [increase=0]              Amount to increase the die count.
+   * @param {object} [options={}]
+   * @param {Set<string>} [options.modifiers]  Additional modifiers to apply to the formula, if possible.
    * @returns {string}
    * @protected
    */
-  _automaticFormula(increase=0) {
+  _automaticFormula(increase=0, { modifiers }={}) {
     let formula;
     const number = (this.number ?? 0) + increase;
-    if ( number && this.denomination ) formula = `${number}d${this.denomination}`;
+    if ( number && this.denomination ) {
+      formula = `${number}d${this.denomination}${Array.from(this.modifiers).concat(modifiers ?? []).join("")}`;
+    }
     if ( this.bonus ) formula = formula ? `${formula} + ${this.bonus}` : this.bonus;
     return formula ?? "";
   }
 
   /* -------------------------------------------- */
 
+  /**
+   * Produce the manual formula from the `custom.formula` and `modifiers` (if possible).
+   * @param {object} [options={}]
+   * @param {Set<string>} [options.modifiers]  Additional modifiers to apply to the formula, if possible.
+   * @returns {string}
+   * @protected
+   */
+  _manualFormula({ modifiers }={}) {
+    if ( !this.custom.formula ) return "";
+    modifiers = Array.from(this.modifiers).concat(modifiers ?? []).join("");
+    return this.custom.formula.replace(/(?:\d|\))d(?:\d+\w*|\(.+\)\d*\w*)/, `$&${modifiers}`);
+  }
+
+  /* -------------------------------------------- */
+
   /**
    * Scale the damage by a number of steps using its configured scaling configuration.
-   * @param {number|Scaling} increase  Number of steps above base damage to scaling.
+   * @param {number|Scaling} increase          Number of steps above base damage to scaling.
+   * @param {object} [options={}]
+   * @param {Set<string>} [options.modifiers]  Additional modifiers to apply to the formula, if possible.
    * @returns {string}
    */
-  scaledFormula(increase) {
+  scaledFormula(increase, { modifiers }={}) {
     if ( increase instanceof Scaling ) increase = increase.increase;
 
     switch ( this.scaling.mode ) {
       case "whole": break;
       case "half": increase = Math.floor(increase * .5); break;
       default: increase = 0; break;
     }
-    if ( !increase ) return this.formula;
+    if ( !increase ) return this.custom.enabled ? this._manualFormula() : this._automaticFormula(0, { modifiers });
     let formula;
 
     // If dice count scaling, increase the count on the first die rolled
     const dieIncrease = (this.scaling.number ?? 0) * increase;
     if ( this.custom.enabled ) {
-      formula = this.custom.formula;
+      formula = this._manualFormula({ modifiers });
       formula = formula.replace(/^(\d)+d/, (match, number) => `${Number(number) + dieIncrease}d`);
     } else {
-      formula = this._automaticFormula(dieIncrease);
+      formula = this._automaticFormula(dieIncrease, { modifiers });
     }
 
     // If custom scaling included, modify to match increase and append for formula

templates/activity/parts/damage-part.hbs

@@ -34,10 +34,14 @@
     {{/unless}}
 </div>
 
+<div class="field-group">
+    {{ formField fields.modifiers name=(concat prefix "modifiers") value=source.modifiers label="DND5E.RollModifiers"
+                 localize=true classes="label-top multi-select" rootId=@root.partId }}
+</div>
+
 <div class="field-group">
     {{ formField fields.types name=(concat prefix "types") value=source.types options=typeOptions hint=false
-                 label="DND5E.Type" localize=true classes="label-top multi-select"
-                 rootId=@root.partId }}
+                 label="DND5E.Type" localize=true classes="label-top multi-select" rootId=@root.partId }}
 </div>
 
 {{#if canScale}}

templates/shared/fields/field-damage.hbs

@@ -35,6 +35,10 @@
 </div>
 {{/unless}}
 
+{{!-- Modifiers --}}
+{{ formField fields.modifiers name=(concat prefix "modifiers") value=source.modifiers label="DND5E.RollModifiers"
+             localize=true rootId=@root.partId }}
+
 {{!-- Types --}}
 {{#if types}}
 {{ formField fields.types name=(concat prefix "types") value=source.types options=types label="DND5E.Type"