addStowedItems

- Add 'addStowedItems' module setting.
Larkinabout · Jun 30, 2023 · 40bb86d · 40bb86d
1 parent 776bfb4
commit 40bb86d
Show file tree

Hide file tree

Showing 15 changed files with 168 additions and 6 deletions.
diff --git a/languages/br.json b/languages/br.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/cn.json b/languages/cn.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/de.json b/languages/de.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/en.json b/languages/en.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/es.json b/languages/es.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/fr.json b/languages/fr.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/it.json b/languages/it.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/ja.json b/languages/ja.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/ko.json b/languages/ko.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/pl.json b/languages/pl.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/languages/zh-tw.json b/languages/zh-tw.json
@@ -37,6 +37,16 @@
                     "hint": "Choose whether to add damage and critical actions for strikes by default",
                     "name": "Add Damage and Critical"
                 },
+                "addStowedItems": {
+                    "hint": "Choose where to add stowed items",
+                    "name": "Add Stowed Items",
+                    "choices": {
+                        "containers": "Container Groups Only",
+                        "nonContainers": "Non-Container Groups Only",
+                        "both": "Container and Non-Container Groups",
+                        "none": "No Groups"
+                    }
+                },
                 "addUnequippedItems": {
                     "hint": "Choose whether to add unequipped items by default",
                     "name": "Add Unequipped Items"

diff --git a/module.json b/module.json
@@ -19,7 +19,7 @@
   "version": "This is auto replaced",
   "compatibility": {
     "minimum": "10",
-    "verified": "11.301"
+    "verified": "11.304"
   },
   "esmodules": [
     "./scripts/token-action-hud-pf2e.min.js"
@@ -108,7 +108,7 @@
           {
             "minimum": "1.4.8",
             "maximum": "1.4",
-            "verified": "1.4.9"
+            "verified": "1.4.10"
           }
         ]
       }

diff --git a/scripts/action-handler.js b/scripts/action-handler.js
@@ -56,6 +56,7 @@ Hooks.once('tokenActionHudCoreApiReady', async (coreModule) => {
             this.showStrikeNames = Utils.getSetting('showStrikeNames')
             this.splitStrikes = Utils.getSetting('splitStrikes')
             this.addDamageAndCritical = Utils.getSetting('addDamageAndCritical')
+            this.addStowedItems = Utils.getSetting('addStowedItems')
             this.addUnequippedItems = Utils.getSetting('addUnequippedItems')
 
             // Set group variables
@@ -662,9 +663,10 @@ Hooks.once('tokenActionHudCoreApiReady', async (coreModule) => {
             for (const [key, value] of this.items) {
                 const hasQuantity = value.system?.quantity > 0
                 const isEquippedItem = this.#isEquippedItem(value)
+                const isAddItem = this.#isAddItem('nonContainer', value)
                 const type = value.type
 
-                if (hasQuantity) {
+                if (hasQuantity && isAddItem) {
                     const itemType = isEquippedItem ? 'equipped' : 'unequipped'
                     const itemCategoryMap = inventoryMap.get(itemType) ?? new Map()
                     itemCategoryMap.set(key, value)
@@ -748,10 +750,18 @@ Hooks.once('tokenActionHudCoreApiReady', async (coreModule) => {
                     // Add group to action list
                     await this.addGroup(groupData, parentGroupData)
 
-                    const items = new Map(contents.map(content => [content.id, content]))
+                    const contentsMap = new Map()
+
+                    for (const content of contents) {
+                        const isAddItem = this.#isAddItem('container', content)
+
+                        if (isAddItem) {
+                            contentsMap.set(content.id, content)
+                        }
+                    }
 
                     const actions = await Promise.all(
-                        [...items].map(async ([_, itemData]) => {
+                        [...contentsMap].map(async ([_, itemData]) => {
                             const id = this.#getActionId(itemData)
                             const name = this.#getActionName(itemData)
                             const listName = this.#getActionListName(itemData, actionType)
@@ -1667,6 +1677,26 @@ Hooks.once('tokenActionHudCoreApiReady', async (coreModule) => {
             return false
         }
 
+        #isAddItem (groupType, item) {
+            if (item.system.equipped?.carryType !== 'stowed') return true
+            return this.#isAddStowedItem(groupType, item)
+        }
+
+        /**
+         * Is add stowed item
+         * @private
+         * @param {string} groupType The group type: container or nonContainer
+         * @param {object} item      The item
+         * @returns {boolean}        Whether the stowed item should be added to the group
+         */
+        #isAddStowedItem (groupType, item) {
+            if (item.system.equipped?.carryType !== 'stowed') return true
+            if (this.addStowedItems === 'both') return true
+            if (groupType === 'container' && this.addStowedItems === 'containers') return true
+            if (groupType === 'nonContainer' && this.addStowedItems === 'nonContainers') return true
+            return false
+        }
+
         /**
          * Get item info
          * @private

diff --git a/scripts/settings.js b/scripts/settings.js
@@ -97,6 +97,28 @@ export function register (updateFunc) {
         }
     })
 
+    game.settings.register(MODULE.ID, 'addStowedItems', {
+        name: game.i18n.localize(
+            'tokenActionHud.pf2e.settings.addStowedItems.name'
+        ),
+        hint: game.i18n.localize(
+            'tokenActionHud.pf2e.settings.addStowedItems.hint'
+        ),
+        scope: 'client',
+        config: true,
+        type: String,
+        default: 'containers',
+        choices: {
+            containers: game.i18n.localize('tokenActionHud.pf2e.settings.addStowedItems.choices.containers'),
+            nonContainers: game.i18n.localize('tokenActionHud.pf2e.settings.addStowedItems.choices.nonContainers'),
+            both: game.i18n.localize('tokenActionHud.pf2e.settings.addStowedItems.choices.both'),
+            none: game.i18n.localize('tokenActionHud.pf2e.settings.addStowedItems.choices.none')
+        },
+        onChange: (value) => {
+            updateFunc(value)
+        }
+    })
+
     game.settings.register(MODULE.ID, 'addUnequippedItems', {
         name: game.i18n.localize(
             'tokenActionHud.pf2e.settings.addUnequippedItems.name'

diff --git a/scripts/token-action-hud-pf2e.min.js b/scripts/token-action-hud-pf2e.min.js