Merge branch 'macro-for-generic-check' into 'master'

Add a macro to perform generic checks

See merge request dungeonslayers/ds4!107

src/lang/de.json

@@ -21,7 +21,8 @@
     "DS4.HeadingSpecialCreatureAbilities": "Besondere Fähigkeiten",
     "DS4.AttackType": "Angriffsart",
     "DS4.AttackTypeAbbr": "AA",
-    "DS4.AttackTypeSelection": "Welche Angriffsart?",
+    "DS4.DialogAttackTypeSelection": "Welche Angriffsart?",
+    "DS4.DialogAttributeTraitSelection": "Welches Attribut und welche Eigenschaft?",
     "DS4.WeaponBonus": "Waffenbonus",
     "DS4.WeaponBonusAbbr": "WB",
     "DS4.OpponentDefense": "Gegnerabwehr",
@@ -122,9 +123,11 @@
     "DS4.SpellPrice": "Preis (Gold)",
     "DS4.ActorTypeCharacter": "Charakter",
     "DS4.ActorTypeCreature": "Kreatur",
+    "DS4.Attribute": "Attribut",
     "DS4.AttributeBody": "Körper",
     "DS4.AttributeMobility": "Agilität",
     "DS4.AttributeMind": "Geist",
+    "DS4.Trait": "Eigenschaft",
     "DS4.TraitStrength": "Stärke",
     "DS4.TraitConstitution": "Härte",
     "DS4.TraitAgility": "Bewegung",
@@ -204,6 +207,8 @@
     "DS4.ErrorRollingForItemTypeNotPossible": "Würfeln ist für Items vom Typ '{type}' nicht möglich.",
     "DS4.ErrorWrongItemType": "Ein Item vom Type '{expectedType}' wurde erwartet aber das Item '{name}' ({id}) ist vom Typ '{actualType}'.",
     "DS4.ErrorUnexpectedAttackType": "Unerwartete Angriffsart '{actualType}', erwartete Angriffsarten: {expectedTypes}",
+    "DS4.ErrorUnexpectedAttribute": "Unerwartetes Attribut '{actualAttribute}', erwartete Attribute: {expectedTypes}",
+    "DS4.ErrorUnexpectedTrait": "Unerwartete Eigenschaft '{actualTrait}', erwartete Eigenschaften: {expectedTypes}",
     "DS4.ErrorCanvasIsNotInitialized": "Canvas ist noch nicht initialisiert.",
     "DS4.ErrorCannotDragMissingCheck": "Die Probe '{check}' per Drag & Drop zu ziehen ist nicht möglich, denn sie existiert nicht.",
     "DS4.WarningItemMustBeEquippedToBeRolled": "Um für das Item '{name}' ({id}) vom Typ '{type}' zu würfeln, muss es ausgerüstet sein.",
@@ -232,17 +237,17 @@
     "DS4.UnitCustomAbbr": " ",
     "DS4.GenericOkButton": "OK",
     "DS4.GenericCancelButton": "Abbrechen",
-    "DS4.RollDialogDefaultTitle": "Proben-Optionen",
+    "DS4.DialogRollOptionsDefaultTitle": "Proben-Optionen",
     "DS4.ErrorUnexpectedHtmlType": "Typfehler: Erwartet wurde '{exType}', tatsächlich erhalten wurde '{realType}'.",
     "DS4.ErrorCouldNotFindForm": "Konnte HTML Element '{htmlElement}' nicht finden.",
     "DS4.ErrorActorDoesNotHaveItem": "Der Aktor '{actor}' hat kein Item mit der ID '{id}'.",
     "DS4.ErrorUnexpectedError": "Es gab einen unerwarteten Fehler im Dungeonslayers 4 System. Für mehr Details schauen Sie bitte in die Konsole (F12).",
     "DS4.ErrorItemDoesNotHaveEffect": "Das Item '{item}' hat keinen Effekt mit der ID '{id}'.",
-    "DS4.RollDialogCheckTargetNumberLabel": "Probenwert",
+    "DS4.DialogRollOptionsCheckTargetNumberLabel": "Probenwert",
-    "DS4.RollDialogGMModifierLabel": "SL-Modifikator",
+    "DS4.DialogRollOptionsGMModifierLabel": "SL-Modifikator",
-    "DS4.RollDialogMaximumCoupResultLabel": "Immersieg bis",
+    "DS4.DialogRollOptionsMaximumCoupResultLabel": "Immersieg bis",
-    "DS4.RollDialogMinimumFumbleResultLabel": "Patzer ab",
+    "DS4.DialogRollOptionsMinimumFumbleResultLabel": "Patzer ab",
-    "DS4.RollDialogRollModeLabel": "Sichtbarkeit",
+    "DS4.DialogRollOptionsRollModeLabel": "Sichtbarkeit",
     "DS4.TooltipBaseValue": "Basiswert",
     "DS4.TooltipModifier": "Modifikator",
     "DS4.TooltipEffects": "Effekte",
@@ -279,5 +284,6 @@
     "DS4.ChecksWakeUp": "Erwachen",
     "DS4.ChecksWorkMechanism": "Mechanismus Öffnen",
     "DS4.ActorCheckFlavor": "{actor} würfelt eine {check} Probe.",
+    "DS4.ActorGenericCheckFlavor": "{actor} würfelt eine Probe gegen {attribute} + {trait}.",
     "DS4.CheckTooltip": "{check} Probe würfeln"
 }

src/lang/en.json

@@ -21,7 +21,8 @@
     "DS4.HeadingSpecialCreatureAbilities": "Special Abilities",
     "DS4.AttackType": "Attack Type",
     "DS4.AttackTypeAbbr": "AT",
-    "DS4.AttackTypeSelection": "Which Attack Type?",
+    "DS4.DialogAttackTypeSelection": "Which Attack Type?",
+    "DS4.DialogAttributeTraitSelection": "Which Attribute and Trait?",
     "DS4.WeaponBonus": "Weapon Bonus",
     "DS4.WeaponBonusAbbr": "WB",
     "DS4.OpponentDefense": "Opponent Defense",
@@ -122,9 +123,11 @@
     "DS4.SpellPrice": "Price (Gold)",
     "DS4.ActorTypeCharacter": "Character",
     "DS4.ActorTypeCreature": "Creature",
+    "DS4.Attribute": "Attribute",
     "DS4.AttributeBody": "Body",
     "DS4.AttributeMobility": "Mobility",
     "DS4.AttributeMind": "Mind",
+    "DS4.Trait": "Trait",
     "DS4.TraitStrength": "Strength",
     "DS4.TraitConstitution": "Constitution",
     "DS4.TraitAgility": "Agility",
@@ -204,6 +207,8 @@
     "DS4.ErrorRollingForItemTypeNotPossible": "Rolling is not possible for items of type '{type}'.",
     "DS4.ErrorWrongItemType": "Expected an item of type '{expectedType}' but item '{name}' ({id}) is of type '{actualType}'.",
     "DS4.ErrorUnexpectedAttackType": "Unexpected attack type '{actualType}', expected it to be one of: {expectedTypes}",
+    "DS4.ErrorUnexpectedAttribute": "Unexpected attribute '{actualAttribute}', expected it to be one of: {expectedTypes}",
+    "DS4.ErrorUnexpectedTrait": "Unexpected trait '{actualTrait}', expected it to be one of: {expectedTypes}",
     "DS4.ErrorCanvasIsNotInitialized": "Canvas is not initialized yet.",
     "DS4.ErrorCannotDragMissingCheck": "Trying to drag the check '{check}' but no such check exists.",
     "DS4.WarningItemMustBeEquippedToBeRolled": "To roll for item '{name}' ({id}) of type '{type}', it needs to be equipped.",
@@ -232,17 +237,17 @@
     "DS4.UnitCustomAbbr": " ",
     "DS4.GenericOkButton": "Ok",
     "DS4.GenericCancelButton": "Cancel",
-    "DS4.RollDialogDefaultTitle": "Roll Options",
+    "DS4.DialogRollOptionsDefaultTitle": "Roll Options",
     "DS4.ErrorUnexpectedHtmlType": "Type Error: Expected '{exType}' but got '{realType}'.",
     "DS4.ErrorCouldNotFindForm": "Could not find HTML element '{htmlElement}'.",
     "DS4.ErrorActorDoesNotHaveItem": "The actor '{actor}' does not have any item with the id '{id}'.",
     "DS4.ErrorUnexpectedError": "There was an unexpected error in the Dungeonslayers 4 system. For more details, please take a look at the console (F12).",
     "DS4.ErrorItemDoesNotHaveEffect": "The item '{item}' does not have any effect with the id '{id}'.",
-    "DS4.RollDialogCheckTargetNumberLabel": "Check Target Number",
+    "DS4.DialogRollOptionsCheckTargetNumberLabel": "Check Target Number",
-    "DS4.RollDialogGMModifierLabel": "Game Master Modifier",
+    "DS4.DialogRollOptionsGMModifierLabel": "Game Master Modifier",
-    "DS4.RollDialogMaximumCoupResultLabel": "Coup to",
+    "DS4.DialogRollOptionsMaximumCoupResultLabel": "Coup to",
-    "DS4.RollDialogMinimumFumbleResultLabel": "Fumble from",
+    "DS4.DialogRollOptionsMinimumFumbleResultLabel": "Fumble from",
-    "DS4.RollDialogRollModeLabel": "Visibility",
+    "DS4.DialogRollOptionsRollModeLabel": "Visibility",
     "DS4.TooltipBaseValue": "Base Value",
     "DS4.TooltipModifier": "Modifier",
     "DS4.TooltipEffects": "Effects",
@@ -279,5 +284,6 @@
     "DS4.ChecksWakeUp": "Wake Up",
     "DS4.ChecksWorkMechanism": "Work Mechanism",
     "DS4.ActorCheckFlavor": "{actor} rolls a {check} check.",
+    "DS4.ActorGenericCheckFlavor": "{actor} rolls a check against {attribute} + {trait}.",
     "DS4.CheckTooltip": "Roll a {check} check"
 }

src/module/actor/actor-data.ts

@@ -21,30 +21,32 @@ interface DS4ActorDataDataBase {
     combatValues: DS4ActorDataDataCombatValues;
 }
 
-interface DS4ActorDataDataAttributes {
+type DS4ActorDataDataAttributes = { [Key in keyof typeof DS4.i18n.attributes]: ModifiableDataBase<number> };
-    body: ModifiableDataBase<number>;
+
-    mobility: ModifiableDataBase<number>;
+type Attribute = keyof DS4ActorDataDataAttributes;
-    mind: ModifiableDataBase<number>;
+
+export function isAttribute(value: unknown): value is Attribute {
+    return (Object.keys(DS4.i18n.attributes) as Array<unknown>).includes(value);
 }
 
-interface DS4ActorDataDataTraits {
+type DS4ActorDataDataTraits = { [Key in keyof typeof DS4.i18n.traits]: ModifiableDataBase<number> };
-    strength: ModifiableDataBase<number>;
+
-    constitution: ModifiableDataBase<number>;
+type Trait = keyof DS4ActorDataDataTraits;
-    agility: ModifiableDataBase<number>;
+
-    dexterity: ModifiableDataBase<number>;
+export function isTrait(value: unknown): value is Trait {
-    intellect: ModifiableDataBase<number>;
+    return (Object.keys(DS4.i18n.traits) as Array<unknown>).includes(value);
-    aura: ModifiableDataBase<number>;
 }
 
-interface DS4ActorDataDataCombatValues {
+type DS4ActorDataDataCombatValues = {
-    hitPoints: ResourceData<number>;
+    [Key in keyof typeof DS4.i18n.combatValues]: Key extends "hitPoints"
-    defense: ModifiableData<number>;
+        ? ResourceData<number>
-    initiative: ModifiableData<number>;
+        : ModifiableData<number>;
-    movement: ModifiableData<number>;
+};
-    meleeAttack: ModifiableData<number>;
+
-    rangedAttack: ModifiableData<number>;
+type CombatValue = keyof DS4ActorDataDataCombatValues;
-    spellcasting: ModifiableData<number>;
+
-    targetedSpellcasting: ModifiableData<number>;
+export function isCombatValue(value: string): value is CombatValue {
+    return (Object.keys(DS4.i18n.combatValues) as Array<unknown>).includes(value);
 }
 
 // types

src/module/actor/actor-prepared-data.ts

@@ -26,31 +26,17 @@ interface DS4ActorPreparedDataDataBase {
     checks: DS4ActorPreparedDataDataChecks;
 }
 
-interface DS4ActorPreparedDataDataAttributes {
+type DS4ActorPreparedDataDataAttributes = {
-    body: ModifiableDataBaseTotal<number>;
+    [Key in keyof typeof DS4.i18n.attributes]: ModifiableDataBaseTotal<number>;
-    mobility: ModifiableDataBaseTotal<number>;
+};
-    mind: ModifiableDataBaseTotal<number>;
-}
 
-interface DS4ActorPreparedDataDataTraits {
+type DS4ActorPreparedDataDataTraits = { [Key in keyof typeof DS4.i18n.traits]: ModifiableDataBaseTotal<number> };
-    strength: ModifiableDataBaseTotal<number>;
-    constitution: ModifiableDataBaseTotal<number>;
-    agility: ModifiableDataBaseTotal<number>;
-    dexterity: ModifiableDataBaseTotal<number>;
-    intellect: ModifiableDataBaseTotal<number>;
-    aura: ModifiableDataBaseTotal<number>;
-}
 
-interface DS4ActorPreparedDataDataCombatValues {
+type DS4ActorPreparedDataDataCombatValues = {
-    hitPoints: ResourceDataBaseTotalMax<number>;
+    [Key in keyof typeof DS4.i18n.combatValues]: Key extends "hitPoints"
-    defense: ModifiableDataBaseTotal<number>;
+        ? ResourceDataBaseTotalMax<number>
-    initiative: ModifiableDataBaseTotal<number>;
+        : ModifiableDataBaseTotal<number>;
-    movement: ModifiableDataBaseTotal<number>;
+};
-    meleeAttack: ModifiableDataBaseTotal<number>;
-    rangedAttack: ModifiableDataBaseTotal<number>;
-    spellcasting: ModifiableDataBaseTotal<number>;
-    targetedSpellcasting: ModifiableDataBaseTotal<number>;
-}
 
 interface DS4ActorPreparedDataDataRolling {
     maximumCoupResult: number;

src/module/actor/actor.ts

@@ -3,7 +3,7 @@ import { DS4 } from "../config";
 import { DS4Item } from "../item/item";
 import { ItemType } from "../item/item-data";
 import { createCheckRoll } from "../rolls/check-factory";
-import { DS4ActorData } from "./actor-data";
+import { DS4ActorData, isAttribute, isTrait } from "./actor-data";
 import { Check, DS4ActorPreparedData } from "./actor-prepared-data";
 
 /**
@@ -291,4 +291,73 @@ export class DS4Actor extends Actor<DS4ActorData, DS4Item, DS4ActorPreparedData>
             flavor: game.i18n.format("DS4.ActorCheckFlavor", { actor: this.name, check: DS4.i18n.checks[check] }),
         });
     }
+
+    /**
+     * Roll a generic check. A dialog is presented to select the combination of
+     * Attribute and Trait to perform the check against.
+     */
+    async rollGenericCheck(): Promise<void> {
+        const { attribute, trait } = await this.selectAttributeAndTrait();
+        const checkTargetNumber = this.data.data.attributes[attribute].total + this.data.data.traits[trait].total;
+        await createCheckRoll(checkTargetNumber, {
+            rollMode: game.settings.get("core", "rollMode") as Const.DiceRollMode, // TODO(types): Type this setting in upstream
+            maximumCoupResult: this.data.data.rolling.maximumCoupResult,
+            minimumFumbleResult: this.data.data.rolling.minimumFumbleResult,
+            flavor: game.i18n.format("DS4.ActorGenericCheckFlavor", {
+                actor: this.name,
+                attribute: DS4.i18n.attributes[attribute],
+                trait: DS4.i18n.traits[trait],
+            }),
+        });
+    }
+
+    protected async selectAttributeAndTrait(): Promise<{
+        attribute: keyof typeof DS4.i18n.attributes;
+        trait: keyof typeof DS4.i18n.traits;
+    }> {
+        const attributeIdentifier = "attribute-trait-selection-attribute";
+        const traitIdentifier = "attribute-trait-selection-trait";
+        return Dialog.prompt({
+            title: game.i18n.localize("DS4.DialogAttributeTraitSelection"),
+            content: await renderTemplate("systems/ds4/templates/dialogs/simple-select-form.hbs", {
+                selects: [
+                    {
+                        label: game.i18n.localize("DS4.Attribute"),
+                        identifier: attributeIdentifier,
+                        options: DS4.i18n.attributes,
+                    },
+                    {
+                        label: game.i18n.localize("DS4.Trait"),
+                        identifier: traitIdentifier,
+                        options: DS4.i18n.traits,
+                    },
+                ],
+            }),
+            label: game.i18n.localize("DS4.GenericOkButton"),
+            callback: (html) => {
+                const selectedAttribute = html.find(`#${attributeIdentifier}`).val();
+                if (!isAttribute(selectedAttribute)) {
+                    throw new Error(
+                        game.i18n.format("DS4.ErrorUnexpectedAttribute", {
+                            actualAttribute: selectedAttribute,
+                            expectedTypes: "'body', 'agility', 'mind'",
+                        }),
+                    );
+                }
+                const selectedTrait = html.find(`#${traitIdentifier}`).val();
+                if (!isTrait(selectedTrait)) {
+                    throw new Error(
+                        game.i18n.format("DS4.ErrorUnexpectedTrait", {
+                            actualTrait: selectedTrait,
+                            expectedTypes: "'strength', 'constitution', 'agility', 'dexterity', 'intellect', 'aura'",
+                        }),
+                    );
+                }
+                return {
+                    attribute: selectedAttribute,
+                    trait: selectedTrait,
+                };
+            },
+        });
+    }
 }

src/module/item/item.ts

@@ -156,13 +156,16 @@ export class DS4Item extends Item<DS4ItemData, DS4ItemPreparedData> {
         if (attackType === "meleeRanged") {
             const { melee, ranged } = { ...DS4.i18n.attackTypes };
             const identifier = "attack-type-selection";
-            const label = game.i18n.localize("DS4.AttackType");
             const answer = Dialog.prompt({
-                title: game.i18n.localize("DS4.AttackTypeSelection"),
+                title: game.i18n.localize("DS4.DialogAttackTypeSelection"),
                 content: await renderTemplate("systems/ds4/templates/dialogs/simple-select-form.hbs", {
-                    label,
+                    selects: [
+                        {
+                            label: game.i18n.localize("DS4.AttackType"),
                             identifier,
                             options: { melee, ranged },
+                        },
+                    ],
                 }),
                 label: game.i18n.localize("DS4.GenericOkButton"),
                 callback: (html) => {

src/module/macros/macros.ts

@@ -1,7 +1,9 @@
 import { rollCheck } from "./roll-check";
+import { rollGenericCheck } from "./roll-generic-check";
 import { rollItem } from "./roll-item";
 
 export const macros = {
     rollCheck,
+    rollGenericCheck,
     rollItem,
 };

src/module/macros/roll-generic-check.ts

@@ -0,0 +1,13 @@
+import notifications from "../ui/notifications";
+import { getActiveActor } from "./helpers";
+/**
+ * Executes the roll generic check macro.
+ */
+export async function rollGenericCheck(): Promise<void> {
+    const actor = getActiveActor();
+    if (!actor) {
+        return notifications.warn(game.i18n.localize("DS4.WarningMustControlActorToUseRollCheckMacro"));
+    }
+
+    return actor.rollGenericCheck();
+}

src/module/rolls/check-factory.ts

@@ -107,7 +107,7 @@ async function askGmModifier(
     { template, title }: { template?: string; title?: string } = {},
 ): Promise<Partial<IntermediateGmModifierData>> {
     const usedTemplate = template ?? "systems/ds4/templates/dialogs/roll-options.hbs";
-    const usedTitle = title ?? game.i18n.localize("DS4.RollDialogDefaultTitle");
+    const usedTitle = title ?? game.i18n.localize("DS4.DialogRollOptionsDefaultTitle");
     const templateData = {
         title: usedTitle,
         checkTargetNumber: checkTargetNumber,
@@ -119,8 +119,7 @@ async function askGmModifier(
     const renderedHtml = await renderTemplate(usedTemplate, templateData);
 
     const dialogPromise = new Promise<HTMLFormElement>((resolve) => {
-        new Dialog(
+        new Dialog({
-            {
             title: usedTitle,
             content: renderedHtml,
             buttons: {
@@ -152,9 +151,7 @@ async function askGmModifier(
                 },
             },
             default: "ok",
-            },
+        }).render(true);
-            { jQuery: true },
-        ).render(true);
     });
     const dialogForm = await dialogPromise;
     return parseDialogFormData(dialogForm);

src/templates/dialogs/roll-options.hbs

@@ -8,26 +8,26 @@
 --}}
 <form class="ds4-roll-options">
     <div class="form-group">
-        <label for="check-target-number">{{localize "DS4.RollDialogCheckTargetNumberLabel"}}</label>
+        <label for="check-target-number">{{localize "DS4.DialogRollOptionsCheckTargetNumberLabel"}}</label>
         <input id="check-target-number" data-type="Number" type="number" name="check-target-number"
             value="{{checkTargetNumber}}" />
     </div>
     <div class="form-group">
-        <label for="gm-modifier">{{localize "DS4.RollDialogGMModifierLabel"}}</label>
+        <label for="gm-modifier">{{localize "DS4.DialogRollOptionsGMModifierLabel"}}</label>
         <input id="gm-modifier" data-type="Number" type="number" name="gm-modifier" value="0" />
     </div>
     <div class="form-group">
-        <label for="maximum-coup-result">{{localize "DS4.RollDialogMaximumCoupResultLabel"}}</label>
+        <label for="maximum-coup-result">{{localize "DS4.DialogRollOptionsMaximumCoupResultLabel"}}</label>
         <input id="maximum-coup-result" data-type="Number" type="number" name="maximum-coup-result"
             value="{{maximumCoupResult}}" />
     </div>
     <div class="form-group">
-        <label for="minimum-fumble-result">{{localize "DS4.RollDialogMinimumFumbleResultLabel"}}</label>
+        <label for="minimum-fumble-result">{{localize "DS4.DialogRollOptionsMinimumFumbleResultLabel"}}</label>
         <input id="minimum-fumble-result" data-type="Number" type="number" name="minimum-fumble-result"
             value="{{minimumFumbleResult}}" />
     </div>
     <div class="form-group">
-        <label for="roll-mode">{{localize "DS4.RollDialogRollModeLabel"}}</label>
+        <label for="roll-mode">{{localize "DS4.DialogRollOptionsRollModeLabel"}}</label>
         <div class="form-fields">
             <select id="roll-mode" name="roll-mode" data-type="String">
                 {{#select rollMode}}

src/templates/dialogs/simple-select-form.hbs

@@ -1,11 +1,13 @@
 {{!--
-!-- Render a simple form with a single select element. It uses the default form classes of Foundry VTT.
+!-- Render a simple form with select elements. It uses the default form classes of Foundry VTT.
-!-- @param identifier: The identifier to use as id for the select element. Can be used to query the value later on.
+!-- @param selects: An array of objects that each contain the following:
-!-- @param label: Text to display as the label for the select element.
+!---- identifier: The identifier to use as id for the select element. Can be used to query the value later on.
-!-- @param options: Key-value pairs that describe the options. The keys are used for the value attribute of the
+!---- label: Text to display as the label for the select element.
+!---- options: Key-value pairs that describe the options. The keys are used for the value attribute of the
 options, the values are used as content.
 --}}
 <form class="ds4-simple-form">
+    {{#each selects}}
     <div class="form-group">
         <label for="{{identifier}}">{{label}}</label>
         <div class="form-fields">
@@ -16,4 +18,5 @@ options, the values are used as content.
             </select>
         </div>
     </div>
+    {{/each}}
 </form>