Merge branch 'release/0.8.2' into main

Changelog.md

@@ -1,3 +1,7 @@
+## 0.8.2
+Add module config and template config settings to modify how snap-to-grid works. Also added to dnd5e spell config, but this will not affect template previews in dnd5e until [PR](https://github.com/foundryvtt/dnd5e/pull/4649) is accepted. #116.
+Add module config to use a rotating square instead of a circle template. #118.
+
 ## 0.8.1
 Dnd5e v4 compatibility. #128.
 Tidy sheets compatibility. #129. Thanks @morepurplemorebetter!

languages/en.json

@@ -126,9 +126,11 @@
     "walledtemplates.settings.hideHighlighting.Name": "Hide template highlighting",
     "walledtemplates.settings.hideHighlighting.Hint": "Unless hovering over the template control icon, do not show the highlighted grid for the template.",
 
-     "walledtemplates.settings.showOnHover.Name": "Show on token hover",
+    "walledtemplates.settings.showOnHover.Name": "Show on token hover",
     "walledtemplates.settings.showOnHover.Hint": "When hovering over a token, show grid highlighting for all hidden templates that overlap that token's border.",
 
+    "walledtemplates.settings.circleSquare.Name": "Replace Circles with Squares",
+
     "walledtemplates.controls.autotarget.Title": "Autotarget tokens with template",
 
     "walledtemplates.notifications.attach-last-selected-token": "Please select a token to attach.",

module.json

@@ -6,7 +6,7 @@
   "library": false,
   "compatibility": {
     "minimum": "12",
-    "verified": "12.327"
+    "verified": "12.331"
   },
   "authors": [
     {

scripts/changelog.js

@@ -196,6 +196,20 @@ Hooks.once("ready", () => {
           (Sorry, you may need to update the template elevation manually if you had relied on the walled template elevation previously.)`
     })
 
+    .addEntry({
+      version: "0.8.2",
+      title: "Snap-to-grid and Square Circles",
+      body: `\
+          In the default template settings, you can now set how snap-to-grid works for each template shape.
+          As with other defaults, you can modify this on a per-template basis in the template configuration.
+
+          If you are using dnd5e, you can also modify the snap settings on a per-spell basis. Unfortunately,
+          the preview template will not respect this setting until this PR is accepted.
+          https://github.com/foundryvtt/dnd5e/pull/4649
+
+          I also added an option, in the module configuration, to use rotating squares instead of circles.`
+    })
+
     .build()
     ?.render(true);
 });

scripts/module.js

@@ -38,6 +38,7 @@ import { WalledTemplateCone } from "./template_shapes/WalledTemplateCone.js";
 import { WalledTemplateRay } from "./template_shapes/WalledTemplateRay.js";
 import { WalledTemplateRoundedCone } from "./template_shapes/WalledTemplateRoundedCone.js";
 import { WalledTemplateSquare } from "./template_shapes/WalledTemplateSquare.js";
+import { WalledTemplateRotatedSquare } from "./template_shapes/WalledTemplateRotatedSquare.js";
 
 // Self-executing scripts for hooks
 import "./changelog.js";
@@ -102,6 +103,7 @@ Hooks.once("init", function() {
     WalledTemplateRay,
     WalledTemplateRoundedCone,
     WalledTemplateSquare,
+    WalledTemplateRotatedSquare,
 
     PATCHER,
 

scripts/settings.js

@@ -1,6 +1,5 @@
 /* globals
 canvas,
-CONFIG,
 CONST,
 game,
 ui
@@ -12,6 +11,9 @@ import { MODULE_ID, SHAPE_KEYS } from "./const.js";
 import { registerAutotargeting } from "./patching.js";
 import { WalledTemplateShapeSettings } from "./WalledTemplateShapeSettings.js";
 import { ModuleSettingsAbstract } from "./ModuleSettingsAbstract.js";
+import { WalledTemplateShape } from "./template_shapes/WalledTemplateShape.js";
+import { WalledTemplateCircle } from "./template_shapes/WalledTemplateCircle.js";
+import { WalledTemplateRotatedSquare } from "./template_shapes/WalledTemplateRotatedSquare.js";
 
 const KEYBINDINGS = {
   AUTOTARGET: "autoTarget",
@@ -28,7 +30,8 @@ export const SETTINGS = {
     HIGHLIGHTING: "hideHighlighting",
     SHOW_ON_HOVER: "showOnHover"
   },
-  CHANGELOG: "changelog"
+  CHANGELOG: "changelog",
+  CIRCLE_SQUARE: "circleSquare"
 };
 
 SETTINGS.AUTOTARGET = {
@@ -201,6 +204,18 @@ export class Settings extends ModuleSettingsAbstract {
       config: true
     });
 
+    register(KEYS.CIRCLE_SQUARE, {
+      name: localize(`${KEYS.CIRCLE_SQUARE}.Name`),
+      type: Boolean,
+      default: false,
+      scope: "world",
+      config: true,
+      onChange: value => {
+        const shapeCl = value ? WalledTemplateRotatedSquare : WalledTemplateCircle;
+        WalledTemplateShape.shapeCodeRegister.set("circle", shapeCl);
+      }
+    });
+
     // ----- NOTE: Submenu ---- //
 
     for ( const shape of SHAPE_KEYS ) {

scripts/template_shapes/WalledTemplateCircle.js

@@ -32,7 +32,7 @@ export class WalledTemplateCircle extends WalledTemplateShape {
   calculateOriginalShape({ distance } = {}) {
     // Convert to degrees and grid units for Foundry method.
     distance ??= this.distance;
-    distance =  CONFIG.GeometryLib.utils.pixelsToGridUnits(distance);
+    distance = CONFIG.GeometryLib.utils.pixelsToGridUnits(distance);
     return CONFIG.MeasuredTemplate.objectClass.getCircleShape(distance);
     // Pad the circle by one pixel so it better covers expected grid spaces?
     // (Rounding tends to drop spaces on the edge.)

scripts/template_shapes/WalledTemplateRotatedSquare.js

@@ -0,0 +1,74 @@
+/* globals
+CONFIG,
+PIXI
+*/
+/* eslint no-unused-vars: ["error", { "argsIgnorePattern": "^_" }] */
+"use strict";
+
+import { WalledTemplateCircle } from "./WalledTemplateCircle.js";
+
+export class WalledTemplateRotatedSquare extends WalledTemplateCircle {
+
+  /**
+   * Square centered on an origin point.
+   * See dndHelpers for original:
+   * https://github.com/trioderegion/dnd5e-helpers/blob/342548530088f929d5c243ad2c9381477ba072de/scripts/modules/TemplateScaling.js#L91
+   * Conforms with 5-5-5 diagonal rule.
+   * @param {object} [opts]     Optional values to temporarily override the ones in this instance.
+   * @returns {PIXI.Rectangle}
+   */
+  calculateOriginalShape({ distance, direction } = {}) {
+    // distance ??= this.distance;
+
+    // Convert to degrees and grid units for Foundry method.
+    // distance = CONFIG.GeometryLib.utils.pixelsToGridUnits(distance);
+
+    // TODO: Redo for v12's grid settings.
+    // Based on 5-5-5, the square's width should equate to the circle's diameter.
+    // (Consider the diameter of the circle in the X-Y directions.)
+    distance ??= this.distance;
+    const dist2 = distance * 2;
+
+    direction ??= this.direction;
+    const rect = new PIXI.Rectangle(-distance, -distance, dist2, dist2);
+    const poly = rotatePolygon(rect.toPolygon(), direction, new PIXI.Point(0, 0));
+    return poly;
+  }
+}
+
+
+/**
+ * Rotate a polygon a given amount clockwise, in radians.
+ * @param {PIXI.Polygon} poly   The polygon
+ * @param {number} rotation     The amount to rotate clockwise in radians
+ * @param {number} [centroid]   Center of the polygon
+ */
+function rotatePolygon(poly, rotation = 0, centroid) {
+  if ( !rotation ) return poly;
+  centroid ??= poly.center;
+
+  // Translate to 0,0, rotate, translate back based on centroid.
+  const Matrix = CONFIG.GeometryLib.Matrix;
+  const rot = Matrix.rotationZ(rotation, false);
+  const trans = Matrix.translation(-centroid.x, -centroid.y);
+  const revTrans = Matrix.translation(centroid.x, centroid.y);
+  const M = trans.multiply3x3(rot).multiply3x3(revTrans);
+
+  // Multiply by the points of the polygon.
+  const nPoints = poly.points.length * 0.5;
+  const arr = new Array(nPoints);
+  for ( let i = 0; i < nPoints; i += 1 ) {
+    const j = i * 2;
+    arr[i] = [poly.points[j], poly.points[j+1], 1];
+  }
+  const polyM = new Matrix(arr);
+  const rotatedM = polyM.multiply(M);
+
+  const rotatedPoints = new Array(poly.points.length);
+  for ( let i = 0; i < nPoints; i += 1 ) {
+    const j = i * 2;
+    rotatedPoints[j] = rotatedM.arr[i][0];
+    rotatedPoints[j+1] = rotatedM.arr[i][1];
+  }
+  return new PIXI.Polygon(rotatedPoints);
+}

scripts/template_shapes/WalledTemplateSquare.js

@@ -18,10 +18,10 @@ export class WalledTemplateSquare extends WalledTemplateCircle {
    * @returns {PIXI.Rectangle}
    */
   calculateOriginalShape({ distance } = {}) {
-    distance ??= this.distance;
+    // distance ??= this.distance;
 
     // Convert to degrees and grid units for Foundry method.
-    distance = CONFIG.GeometryLib.utils.pixelsToGridUnits(distance);
+    // distance = CONFIG.GeometryLib.utils.pixelsToGridUnits(distance);
 
     // TODO: Redo for v12's grid settings.
     // Based on 5-5-5, the square's width should equate to the circle's diameter.