Merge pull request #118 from death-save:v0.2.5

V0.2.5

Author: eclarke12

CHANGELOG.md

@@ -6,6 +6,18 @@
 - Some strings are still not setup for translation
 - When multiple combatants are added to combat at the same time, and the `Control Active Combatant` setting is enabled, there will be an error in console. It doesn't appear to prevent any Carousel behaviour.
 
+## [0.2.5] - 2021-12-27
+> This update adds compatibility for Foundry VTT V9
+
+- Combat Carousel no longer throws an error if you have a world with no active combat
+- Spanish translation update (again, thanks @lozalojo 🎉)
+- Nav bar automagically re-expands after combat if the collapse setting is enabled (thanks @sirrus233 🎉)
+- Added a setting to open the Carousel on combat creation
+- Lengthened the delay for the fly-in effect on cards when the Carousel is opened
+- Occasionally the Carousel got confused about its collapsed/expanded state. Should happen less now
+- Added additional update properties for actors and tokens that cause the Carousel UI to update
+- Carousel now collapses when combat is deleted
+
 ## [0.2.3] - 2021-10-11
 - Spanish translation updated (thanks @lozalojo ! 🎉)
 - Added options for `Limited` Actor permission to settings that support permissions (thanks @SovietVVinter ! 🎉)

lang/en.json

@@ -35,7 +35,11 @@
             "ControlActiveCombatantTokenN": "Control Active Combatant's Token",
             "ControlActiveCombatantTokenH": "Enable to automatically control (select) the token associated to the currently Active Combatant.",
             "PanOnClickN": "Pan on Card Click",
-            "PanOnClickH": "Pans to the matching token when a card is clicked (note: the token must be 'visible' to the current user)"
+            "PanOnClickH": "Pans to the matching token when a card is clicked (note: the token must be 'visible' to the current user)",
+            "AlwaysOnTopN": "Always On Top",
+            "AlwaysOnTopH": "Always render the Carousel above other UI elements.",
+            "OpenOnCombatCreateN": "Open Combat Carousel on Combat Creation",
+            "OpenOnCombatCreateH": "Opens the Carousel when a Combat is created"
         },
 
         "CAROUSEL": {

lang/es.json

@@ -38,7 +38,9 @@
             "CarouselSizeN": "Tamaño del carrusel",
             "CarouselSizeH": "El tamaño del carrusel en la pantalla. No se rescalarán los elementos de control ni el HUD",
             "ControlActiveCombatantTokenN": "Controlar icono del contendiente activo",
-            "ControlActiveCombatantTokenH": "Habilita el control automático (seleccionar) del icono asociado al contendiente activo actualmente"
+            "ControlActiveCombatantTokenH": "Habilita el control automático (seleccionar) del icono asociado al contendiente activo actualmente",
+            "PanOnClickN": "Centrar al hacer clic en una tarjeta",
+            "PanOnClickH": "Se centra en el icono correspondiente cuando se hace clic en una tarjeta (nota: el icono debe ser 'visible' para el usuario actual)"
         },
 
         "CAROUSEL": {

module.json

@@ -2,7 +2,7 @@
     "name": "combat-carousel",
     "title": "Combat Carousel",
     "description": "Adds a CRPG-style combat tracker to the top of the screen",
-    "version": "0.2.3",
+    "version": "0.2.5",
     "author": "Evan Clarke [errational#2007]",
     "authors": [
       {
@@ -14,8 +14,8 @@
         "patreon": "deathsave"
       }
     ],
-    "minimumCoreVersion": "0.8.5",
-    "compatibleCoreVersion": "0.8.9",
+    "minimumCoreVersion": "9.235",
+    "compatibleCoreVersion": "9.238",
     "url": "https://github.com/death-save/combat-carousel",
     "manifest": "https://github.com/death-save/combat-carousel/releases/latest/download/module.json",
     "download": "https://github.com/death-save/combat-carousel/releases/latest/download/module.zip",
@@ -76,8 +76,8 @@
         "caption":"Combat Carousel launch video"
       }
     ],
-    "manifestPlusVersion": "1.2.0",
     "flags": {
+      "manifestPlusVersion": "1.2.0",
       "allowBugReporter": true
     }
   }

modules/combat-carousel.mjs

@@ -50,14 +50,15 @@ export default class CombatCarousel extends Application {
         // Instantiate the Fixed Draggable to make this app draggable
         new FixedDraggable(this, this.element, this.element.find(".drag-handle")[0], this.options.resizeable, {onDragMouseUp: this._onDragEnd});
 
-        // If set, collapse the Nav bar
-        const collapseNavSetting = game.settings.get(NAME, SETTING_KEYS.collapseNav);
-
-        if (collapseNavSetting && game.combat) ui.nav.collapse();
-
         const sizeSetting = game.settings.get(NAME, SETTING_KEYS.carouselSize);
         const scale = this.sizeFactor = sizeSetting ? DEFAULT_CONFIG.carouselSize.sizeScaleMap[sizeSetting] : 1;
 
+        const alwaysOnTopSetting = game.settings.get(NAME, SETTING_KEYS.alwaysOnTop);
+
+        if (alwaysOnTopSetting) {
+            this.element[0].style.zIndex = 100;
+        }
+
         /**
         * Create a Splide instance and store it for later use
         */
@@ -90,7 +91,7 @@ export default class CombatCarousel extends Application {
             if (force) {
                 for (let i = 0; i < slides.length; i++) {
                     slides[i].classList.add("fly");
-                    slides[i].style.animationDelay = `${0.1 * (i ? i : 1)}s`;
+                    slides[i].style.animationDelay = `${0.2 * (i ? i + 1 : 1)}s`;
 
                     slides[i].addEventListener("animationend", event => {
                         event.target.classList.remove("fly");
@@ -172,6 +173,7 @@ export default class CombatCarousel extends Application {
         await this.splide.mount();
 
         this.setPosition({width: this._getMinimumWidth(), height: 205 * scale});
+        this._collapsed = false;
     }
 
     /**
@@ -246,7 +248,7 @@ export default class CombatCarousel extends Application {
             img,
             initiative: turn.initiative,
             hidden: turn.hidden,
-            visible: turn.isVisible,
+            visible: turn.visible,
             defeated: turn.data.defeated,
             carousel: {
                 isGM: game.user.isGM,
@@ -424,8 +426,11 @@ export default class CombatCarousel extends Application {
 
         const ccButtonHtml = await renderTemplate(`${TEMPLATE_PATH}/combat-carousel-button.hbs`,{carouselIcon});
 
-        html.append(ccButtonHtml);
+        const mainControls = html.find(".control-tools.main-controls");
+
+        if (!mainControls?.length) return;
 
+        mainControls.append(ccButtonHtml);
         const ccButton = html.find("li[data-control='combat-carousel']");
 
         ccButton
@@ -536,7 +541,7 @@ export default class CombatCarousel extends Application {
 
         const token = canvas.tokens.get(combatant.token.id);
 
-        if (!token.owner) return;
+        if (!token.isOwner) return;
 
         if (!combatant.initiative) game.combat.rollInitiative(combatantId);
     }
@@ -703,7 +708,7 @@ export default class CombatCarousel extends Application {
 
         if (!combatant) return;
 
-        const isCtrl = game.keyboard.isCtrl(event);
+        const isCtrl = game.keyboard.isModifierActive(KeyboardManager.MODIFIER_KEYS.CONTROL);
 
         if (isCtrl && game.user.isGM) {
 
@@ -741,7 +746,7 @@ export default class CombatCarousel extends Application {
         const combatantId = card.dataset.combatantId;
         const token = getTokenFromCombatantId(combatantId);
 
-        if (!game.user.isGM || !token.owner) return;
+        if (!game.user.isGM || !token.isOwner) return;
 
         token.actor.sheet.render(true);
     }

modules/config.mjs

@@ -56,7 +56,9 @@ export const SETTING_KEYS = {
     initiativePermission: "initiativePermission",
     imageType: "imageType",
     controlActiveCombatantToken: "controlActiveCombatantToken",
-    panOnClick: "panOnClick"
+    panOnClick: "panOnClick",
+    alwaysOnTop: "alwaysOnTop",
+    openOnCombatCreate: "openOnCombatCreate"
 }
 
 /**

modules/hooks.mjs

@@ -47,11 +47,16 @@ export default function registerHooks() {
      */
     Hooks.on("createCombat", async (combat, createData, options, userId) => {
         const enabled = game.settings.get(NAME, SETTING_KEYS.enabled);
+        const openOnCreate = game.settings.get(NAME, SETTING_KEYS.openOnCombatCreate);
 
-        if (!enabled || !ui.combatCarousel || ui.combatCarousel?._collapsed) return;
+        if (!enabled || !ui.combatCarousel || (ui.combatCarousel?._collapsed && !openOnCreate)) return;
 
         ui.combatCarousel.render(true);
-        
+
+        // If set, collapse the Nav bar
+        const collapseNavSetting = game.settings.get(NAME, SETTING_KEYS.collapseNav);
+        if (collapseNavSetting) ui.nav.collapse();
+
         const hasTurns = combat?.turns?.length;
         const carouselImg = ui?.controls?.element.find("img.carousel-icon");
         const newImgSrc = hasTurns ? CAROUSEL_ICONS.hasTurns : CAROUSEL_ICONS.noTurns;
@@ -107,9 +112,8 @@ export default function registerHooks() {
 
         if (!enabled || ui.combatCarousel?._collapsed) return;
 
-        const hasCombat = game.combats.entities?.length;
-
-        if (!hasCombat) {
+        if (!game.combat) {
+            await ui.combatCarousel.collapse();
             ui.combatCarousel.close();
             //await ui.combatCarousel.render(true);
             //ui.combatCarousel.collapse();
@@ -223,9 +227,9 @@ export default function registerHooks() {
     Hooks.on("updateActor", (actor, updateData, options, userId) => {
         const enabled = game.settings.get(NAME, SETTING_KEYS.enabled);
 
-        if (!enabled || ui.combatCarousel?._collapsed) return;
+        if (!enabled || !game.combat || ui.combatCarousel?._collapsed) return;
 
-        if (!hasProperty(updateData, "data.attributes.hp.value") && !hasProperty(updateData, "img")) return;
+        if (!hasProperty(updateData, "data.attributes.hp") && !hasProperty(updateData, "img") && !hasProperty(updateData, "name")) return;
         // find any matching combat carousel combatants
 
         if (!game.combat?.combatants.some(c => c.actor.id === actor.id)) return;
@@ -239,16 +243,15 @@ export default function registerHooks() {
     Hooks.on("updateToken", (token, updateData, options, userId) => {
         const enabled = game.settings.get(NAME, SETTING_KEYS.enabled);
 
-        if (!enabled || ui.combatCarousel?._collapsed) return;
+        if (!enabled || !game.combat || ui.combatCarousel?._collapsed) return;
 
         //console.log("token update:", scene,token,update,options,userId);
         if (
             !hasProperty(updateData, "effects")
             && !hasProperty(updateData, "overlayEffect")
-            && !hasProperty(updateData, "actorData.effects")
-            && !hasProperty(updateData, "actorData.data.attributes.hp.value") 
+            && !hasProperty(updateData, "actorData")
             && !hasProperty(updateData, "img")
-            && !hasProperty(updateData, "actorData.img")
+            && !hasProperty(updateData, "name")
         ) return;
         // find any matching combat carousel combatants
 
@@ -297,6 +300,9 @@ export default function registerHooks() {
 
         if (!data?.hasCombat && rendered) {
             ui.combatCarousel.close();
+            // If set, re-expand the nav bar after combat closes
+            const collapseNavSetting = game.settings.get(NAME, SETTING_KEYS.collapseNav);
+            if (collapseNavSetting) ui.nav.expand();
         }
 
         if (data?.hasCombat && isViewedCombat && !combatMatch && collapsed === false) {

modules/settings.mjs

@@ -77,6 +77,18 @@ export default function registerSettings() {
         }
     });
 
+    game.settings.register(NAME, SETTING_KEYS.openOnCombatCreate, {
+        name: "COMBAT_CAROUSEL.SETTINGS.OpenOnCombatCreateN",
+        hint: "COMBAT_CAROUSEL.SETTINGS.OpenOnCombatCreateH",
+        scope: "client",
+        type: Boolean,
+        default: false,
+        config: true,
+        onChange: s => {
+
+        }
+    });
+
     game.settings.register(NAME, SETTING_KEYS.carouselSize, {
         name: "COMBAT_CAROUSEL.SETTINGS.CarouselSizeN",
         hint: "COMBAT_CAROUSEL.SETTINGS.CarouselSizeH",
@@ -86,8 +98,10 @@ export default function registerSettings() {
         choices: DEFAULT_CONFIG.carouselSize.choices,
         config: true,
         onChange: async s => {
-            await ui.combatCarousel.render(true);
-            ui.combatCarousel.element.addClass(s);
+            if (ui.combatCarousel?.rendered) {
+                await ui.combatCarousel.render(true);
+                ui.combatCarousel.element.addClass(s);
+            }
         }
     });
 
@@ -100,7 +114,7 @@ export default function registerSettings() {
         choices: DEFAULT_CONFIG.imageType.choices,
         config: true,
         onChange: s => {
-            ui.combatCarousel.render(true);
+            if (ui.combatCarousel?.rendered) ui.combatCarousel.render(true);
         }
     });
 
@@ -126,6 +140,18 @@ export default function registerSettings() {
         }
     });
 
+    game.settings.register(NAME, SETTING_KEYS.alwaysOnTop, {
+        name: "COMBAT_CAROUSEL.SETTINGS.AlwaysOnTopN",
+        hint: "COMBAT_CAROUSEL.SETTINGS.AlwaysOnTopH",
+        scope: "client",
+        type: Boolean,
+        default: false,
+        config: true,
+        onChange: s => {
+            if (ui.combatCarousel?.rendered) ui.combatCarousel.render(true);
+        }
+    });
+
     /* -------------------------------------------------------------------------- */
     /*                              Overlay Settings                              */
     /* -------------------------------------------------------------------------- */