Merge branch 'master' into 005_item_editing

package-lock.json

@@ -2678,8 +2678,8 @@
       }
     },
     "foundry-pc-types": {
-      "version": "gitlab:foundry-projects/foundry-pc/foundry-pc-types#e9cca6fbbe811fb439a3d0cdba7433746530cd97",
+      "version": "git+https://git.f3l.de/dungeonslayers/foundry-pc-types.git#211c36bdde13400f02421dc0f911b255767dac76",
-      "from": "gitlab:foundry-projects/foundry-pc/foundry-pc-types",
+      "from": "git+https://git.f3l.de/dungeonslayers/foundry-pc-types.git#f3l-fixes",
       "dev": true,
       "requires": {
         "@types/jquery": "^3.5.1",

package.json

@@ -9,7 +9,7 @@
         "build:watch": "gulp watch",
         "link": "gulp link",
         "clean": "gulp clean && gulp link --clean",
-        "update": "npm install --save-dev gitlab:foundry-projects/foundry-pc/foundry-pc-types",
+        "update": "npm install --save-dev git+https://git.f3l.de/dungeonslayers/foundry-pc-types.git#f3l-fixes",
         "lint": "eslint 'src/**/*.ts' --cache",
         "lint:fix": "eslint 'src/**/*.ts' --cache --fix"
     },
@@ -23,7 +23,7 @@
         "eslint": "^7.16.0",
         "eslint-config-prettier": "^7.1.0",
         "eslint-plugin-prettier": "^3.3.0",
-        "foundry-pc-types": "gitlab:foundry-projects/foundry-pc/foundry-pc-types",
+        "foundry-pc-types": "git+https://git.f3l.de/dungeonslayers/foundry-pc-types.git#f3l-fixes",
         "fs-extra": "^9.0.1",
         "gulp": "^4.0.2",
         "gulp-git": "^2.10.1",

src/module/actor/actor-data.ts

@@ -1,2 +1,26 @@
-// TODO: Actually add a type for data
+export interface DS4ActorDataType {
-export type DS4ActorDataType = unknown;
+    attributes: DS4ActorDataAttributes;
+    traits: DS4ActorDataTraits;
+}
+
+interface DS4ActorDataAttributes {
+    body: BodyAttribute;
+    mobility: ExtensibleData<number>;
+    mind: ExtensibleData<number>;
+}
+
+interface ExtensibleData<T extends any> {
+    initial: T;
+}
+
+// Blueprint in case we need more detailed differentiation
+type BodyAttribute = ExtensibleData<number>;
+
+interface DS4ActorDataTraits {
+    strength: ExtensibleData<number>;
+    constitution: ExtensibleData<number>;
+    agility: ExtensibleData<number>;
+    dexterity: ExtensibleData<number>;
+    intellect: ExtensibleData<number>;
+    aura: ExtensibleData<number>;
+}

src/module/actor/actor-sheet.ts

@@ -19,18 +19,6 @@ export class DS4ActorSheet extends ActorSheet<DS4ActorDataType, DS4Actor> {
 
     /* -------------------------------------------- */
 
-    /** @override */
-    getData(): ActorSheetData<DS4ActorDataType> {
-        // TODO: replace ["..."] access with .
-        const data = super.getData();
-        data["dtypes"] = ["String", "Number", "Boolean"];
-        for (const attr of Object.values(data.data["attributes"])) {
-            attr["isCheckbox"] = attr["dtype"] === "Boolean";
-        }
-        console.log(data);
-        return data;
-    }
-
     /** @override */
     activateListeners(html: JQuery): void {
         super.activateListeners(html);
@@ -39,17 +27,17 @@ export class DS4ActorSheet extends ActorSheet<DS4ActorDataType, DS4Actor> {
         if (!this.options.editable) return;
 
         // Add Inventory Item
-        html.find(".item-create").click(this._onItemCreate.bind(this));
+        html.find(".item-create").on("click", this._onItemCreate.bind(this));
 
         // Update Inventory Item
-        html.find(".item-edit").click((ev) => {
+        html.find(".item-edit").on("click", (ev) => {
             const li = $(ev.currentTarget).parents(".item");
             const item = this.actor.getOwnedItem(li.data("itemId"));
             item.sheet.render(true);
         });
 
         // Delete Inventory Item
-        html.find(".item-delete").click((ev) => {
+        html.find(".item-delete").on("click", (ev) => {
             const li = $(ev.currentTarget).parents(".item");
             this.actor.deleteOwnedItem(li.data("itemId"));
             li.slideUp(200, () => this.render(false));
@@ -66,7 +54,7 @@ export class DS4ActorSheet extends ActorSheet<DS4ActorDataType, DS4Actor> {
      * @param {Event} event   The originating click event
      * @private
      */
-    _onItemCreate(event: JQuery.ClickEvent): Promise<Item> {
+    private _onItemCreate(event: JQuery.ClickEvent): Promise<Item> {
         event.preventDefault();
         const header = event.currentTarget;
         // Get the type of item to create.
@@ -93,13 +81,13 @@ export class DS4ActorSheet extends ActorSheet<DS4ActorDataType, DS4Actor> {
      * @param {Event} event   The originating click event
      * @private
      */
-    _onRoll(event: JQuery.ClickEvent): void {
+    private _onRoll(event: JQuery.ClickEvent): void {
         event.preventDefault();
         const element = event.currentTarget;
         const dataset = element.dataset;
 
         if (dataset.roll) {
-            const roll = new Roll(dataset.roll, this.actor.data.data as Record<string, unknown>);
+            const roll = new Roll(dataset.roll, this.actor.data.data);
             const label = dataset.label ? `Rolling ${dataset.label}` : "";
             roll.roll().toMessage({
                 speaker: ChatMessage.getSpeaker({ actor: this.actor }),

src/module/actor/actor.ts

@@ -11,29 +11,27 @@ export class DS4Actor extends Actor<DS4ActorDataType> {
         this._prepareCombatValues(data);
     }
 
-    _prepareCombatValues(data: ActorData<DS4ActorDataType>): void {
+    private _prepareCombatValues(data: ActorData<DS4ActorDataType>): void {
         const hitPointsModifier = getProperty(data, "data.combatValues.hitPoints.modifier") || 0;
+        const actorData = data.data;
         setProperty(
             data,
             "data.combatValues.hitPoints.max",
-            data.data["attributes"]["body"].initial + // TODO: replace ["..."]
+            actorData.attributes.body.initial + actorData.traits.constitution.initial + 10 + hitPointsModifier,
-                data.data["traits"]["constitution"].initial + // TODO: replace ["..."]
-                10 +
-                hitPointsModifier,
         );
 
         const defenseModifier = getProperty(data, "data.combatValues.defense.modifier") || 0;
         setProperty(
             data,
             "data.combatValues.defense.value",
-            data.data["attributes"]["body"].initial + // TODO: replace ["..."]
+            actorData.attributes.body.initial +
-                data.data["traits"]["constitution"].initial + // TODO: replace ["..."]
+                actorData.traits.constitution.initial +
                 this._getArmorValue() +
                 defenseModifier,
         );
     }
 
-    _getArmorValue(): number {
+    private _getArmorValue(): number {
         return this.data["items"]
             .filter((item) => ["armor", "shield"].includes(item.type))
             .filter((item) => item.data.equipped)

src/module/config.ts

@@ -1,11 +1,11 @@
 export const DS4 = {
     // ASCII Artwork
-    ASCII: `_____________________________________________________________________________________________
+    ASCII: String.raw`_____________________________________________________________________________________________
  ____  _   _ _   _  ____ _____ ___  _   _ ____  _        _ __   _______ ____  ____    _  _
-|  _ \\| | | | \\ | |/ ___| ____/ _ \\| \\ | / ___|| |      / \\\\ \\ / / ____|  _ \\/ ___|  | || |  
+|  _ \| | | | \ | |/ ___| ____/ _ \| \ | / ___|| |      / \\ \ / / ____|  _ \/ ___|  | || |
-| | | | | | |  \\| | |  _|  _|| | | |  \\| \\___ \\| |     / _ \\\\ V /|  _| | |_) \\___ \\  | || |_ 
+| | | | | | |  \| | |  _|  _|| | | |  \| \___ \| |     / _ \\ V /|  _| | |_) \___ \  | || |_
-| |_| | |_| | |\\  | |_| | |__| |_| | |\\  |___) | |___ / ___ \\| | | |___|  _ < ___) | |__   _|
+| |_| | |_| | |\  | |_| | |__| |_| | |\  |___) | |___ / ___ \| | | |___|  _ < ___) | |__   _|
-|____/ \\___/|_| \\_|\\____|_____\\___/|_| \\_|____/|_____/_/   \\_\\_| |_____|_| \\_\\____/     |_|  
+|____/ \___/|_| \_|\____|_____\___/|_| \_|____/|_____/_/   \_\_| |_____|_| \_\____/     |_|
 =============================================================================================`,
 
     /**
@@ -49,7 +49,7 @@ export const DS4 = {
      */
     armorTypes: {
         body: "DS4.ArmorTypeBody",
-        helment: "DS4.ArmorTypeHelmet",
+        helmet: "DS4.ArmorTypeHelmet",
         vambrace: "DS4.ArmorTypeVambrace",
         greaves: "DS4.ArmorTypeGreaves",
         vambraceGreaves: "DS4.ArmorTypeVambraceGreaves",

src/module/ds4.ts

@@ -18,8 +18,8 @@ Hooks.once("init", async function () {
     CONFIG.DS4 = DS4;
 
     // Define custom Entity classes
-    CONFIG.Actor.entityClass = DS4Actor as typeof Actor; // TODO: Can we remove the casts?
+    CONFIG.Actor.entityClass = DS4Actor as typeof Actor;
-    CONFIG.Item.entityClass = DS4Item as typeof Item; // TODO: Can we remove the casts?
+    CONFIG.Item.entityClass = DS4Item as typeof Item;
 
     // Register sheet application classes
     Actors.unregisterSheet("core", ActorSheet);

src/module/item/item-data.ts

@@ -1,2 +1,38 @@
 // TODO: Actually add a type for data
-export type DS4ItemDataType = unknown;
+export type DS4ItemDataType = DS4Weapon | DS4Armor | DS4Shield | DS4Trinket | DS4Equipment;
+
+// types
+
+interface DS4Weapon extends DS4ItemBase, DS4ItemPhysical, DS4ItemEquipable {
+    attackType: "melee" | "ranged" | "meleeRanged";
+    weaponBonus: number;
+    opponentDefense: number;
+}
+
+interface DS4Armor extends DS4ItemBase, DS4ItemPhysical, DS4ItemEquipable, DS4ItemProtective {
+    armorMaterialType: "cloth" | "leather" | "chain" | "plate";
+    armorType: "body" | "helmet" | "vambrace" | "greaves" | "vambraceGreaves";
+}
+
+interface DS4Shield extends DS4ItemBase, DS4ItemPhysical, DS4ItemEquipable, DS4ItemProtective {}
+interface DS4Trinket extends DS4ItemBase, DS4ItemPhysical, DS4ItemEquipable {}
+interface DS4Equipment extends DS4ItemBase, DS4ItemPhysical {}
+
+// templates
+
+interface DS4ItemBase {
+    description: string;
+}
+interface DS4ItemPhysical {
+    quantity: number;
+    price: number;
+    availability: "hamlet" | "village" | "city" | "elves" | "dwarves" | "none";
+}
+
+interface DS4ItemEquipable {
+    equipped: boolean;
+}
+
+interface DS4ItemProtective {
+    armorValue: number;
+}

src/module/item/item-sheet.ts

@@ -1,4 +1,3 @@
-import { DS4ActorDataType } from "../actor/actor-data";
 import { DS4Item } from "./item";
 import { DS4ItemDataType } from "./item-data";
 
@@ -6,7 +5,7 @@ import { DS4ItemDataType } from "./item-data";
  * Extend the basic ItemSheet with some very simple modifications
  * @extends {ItemSheet}
  */
-export class DS4ItemSheet extends ItemSheet<DS4ActorDataType, DS4Item> {
+export class DS4ItemSheet extends ItemSheet<DS4ItemDataType, DS4Item> {
     /** @override */
     static get defaultOptions(): FormApplicationOptions {
         return mergeObject(super.defaultOptions, {
@@ -26,7 +25,7 @@ export class DS4ItemSheet extends ItemSheet<DS4ActorDataType, DS4Item> {
     /* -------------------------------------------- */
 
     /** @override */
-    getData(): ItemSheetData<DS4ItemDataType> {
+    getData(): ItemSheetData<DS4ItemDataType, DS4Item> {
         const data = { ...super.getData(), config: CONFIG.DS4 };
         console.log(data);
         return data;
@@ -35,11 +34,15 @@ export class DS4ItemSheet extends ItemSheet<DS4ActorDataType, DS4Item> {
     /* -------------------------------------------- */
 
     /** @override */
-    setPosition(options = {}): unknown {
+    setPosition(options: ApplicationPosition = {}): ApplicationPosition {
         const position = super.setPosition(options);
-        const sheetBody = (this.element as JQuery).find(".sheet-body"); // TODO: Why is the cast necessary?
+        if ("find" in this.element) {
+            const sheetBody = this.element.find(".sheet-body");
             const bodyHeight = position.height - 192;
             sheetBody.css("height", bodyHeight);
+        } else {
+            console.log("Failure setting position.");
+        }
         return position;
     }
 
@@ -51,16 +54,16 @@ export class DS4ItemSheet extends ItemSheet<DS4ActorDataType, DS4Item> {
 
         if (!this.options.editable) return;
 
-        html.find(".effect-create").click(this._onEffectCreate.bind(this));
+        html.find(".effect-create").on("click", this._onEffectCreate.bind(this));
 
-        html.find(".effect-edit").click((ev) => {
+        html.find(".effect-edit").on("click", (ev) => {
             const li = $(ev.currentTarget).parents(".effect");
             console.log(li.data("effectId"));
             const effect = this.item["effects"].get(li.data("effectId")); // TODO: replace ["..."]
             effect.sheet.render(true);
         });
 
-        html.find(".effect-delete").click(async (ev) => {
+        html.find(".effect-delete").on("click", async (ev) => {
             const li = $(ev.currentTarget).parents(".effect");
             await this.item.deleteEmbeddedEntity("ActiveEffect", li.data("effectId"));
         });
@@ -71,7 +74,7 @@ export class DS4ItemSheet extends ItemSheet<DS4ActorDataType, DS4Item> {
      * @param {Event} event   The originating click event
      * @private
      */
-    async _onEffectCreate(event: JQuery.ClickEvent): Promise<unknown> {
+    private async _onEffectCreate(event: JQuery.ClickEvent): Promise<unknown> {
         event.preventDefault();
 
         const label = `New Effect`;

src/template.json

@@ -51,24 +51,24 @@
             },
             "equipable": {
                 "equipped": false
+            },
+            "protective": {
+                "armorValue": 0
             }
         },
         "weapon": {
             "templates": ["base", "physical", "equipable"],
             "attackType": "melee",
             "weaponBonus": 0,
-            "opponentDefense": 0,
+            "opponentDefense": 0
-            "properties": {}
         },
         "armor": {
-            "templates": ["base", "physical", "equipable"],
+            "templates": ["base", "physical", "equipable", "protective"],
             "armorMaterialType": "cloth",
-            "armorType": "body",
+            "armorType": "body"
-            "armorValue": 0
         },
         "shield": {
-            "templates": ["base", "physical", "equipable"],
+            "templates": ["base", "physical", "equipable", "protective"]
-            "armorValue": 0
         },
         "trinket": {
             "templates": ["base", "physical", "equipable"]