refactor: Data model cleanup

- address review comments
League-of-Fabulous-Developers · Jan 19, 2025 · 617a074 · 617a074
1 parent 19d1110
commit 617a074
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/module/documents/items/heroic/heroic-skill-data-model.mjs b/module/documents/items/heroic/heroic-skill-data-model.mjs
@@ -62,6 +62,7 @@ export class HeroicSkillDataModel extends foundry.abstract.TypeDataModel {
 		deprecationNotice(this, 'damage.value');
 		deprecationNotice(this, 'damage.type.value');
 		deprecationNotice(this, 'impdamage.hasImpDamage.value');
+		deprecationNotice(this, 'impdamage.value');
 		deprecationNotice(this, 'impdamage.impType.value');
 		deprecationNotice(this, 'impdamage.type.value');
 	}

diff --git a/module/helpers/deprecation-helper.mjs b/module/helpers/deprecation-helper.mjs
@@ -1,6 +1,14 @@
+/**
+ * Track which deprecated method has already been logged.
+ * @type {Set<string>}
+ */
 const alreadyPrinted = new Set();
 
 /**
+ * Add a log message to a removed field in a data model.
+ * For nested fields the required nested objects will be defined on the class.
+ * If the field has no replacement its value will be undefined, and it cannot be set to any other value.
+ * If the field has a designated replacement it will reflect the value of its replacement and will set the value of its replacement.
  * @param {typeof foundry.abstract.DataModel} root the DataModel subclass
  * @param {string} key
  * @param {string} [replacementKey]