Release v1.1.1

As a side effect this will now also show the coloring to other players

CHANGELOG.md

@@ -1,3 +1,19 @@
+## v1.1.1
+### Bugfixes
+- Fixed a bug where tokens wouldn't be moved to the corect end position on gridless maps
+- Ruler now appears immediately when the token is being dragged
+- On gridless maps the ruler will always start measuring at the center of the token
+  - This change has no impact on the distance that is being measured
+  - In addition to the cosmetical aspect this also fixes a bug that allowed players to glitch through walls
+
+## v1.1.0
+### New features
+- The drag ruler will now be colored for other players than the dragging player as well (only if they have at least observer permissions for that token)
+- The drag ruler won't be shown to other players if they cannot see the dragged token
+
+### Bugfixes
+- Fixed a bug where Drag Ruler wouldn't work at all on some windows installations (specificially where the `foundry.js` has `CRLF` line endings)
+
 ## v1.0.1
 ### Bugfixes
 - The GM can now move tokens through walls

README.md

@@ -1,3 +1,5 @@
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/staebchenfisch)
+
 # Drag Ruler
 This module shows a ruler when you drag a token to infrom you how far you've dragged the token from it's start point. Additionally, if you're using a grid, the spaces the token will travel though will be colored depending on your tokens speed.
 

lang/en.json

@@ -1,6 +1,10 @@
 {
 	"drag-ruler": {
 		"settings": {
+			"alwaysShowSpeedForPCs": {
+				"name": "Show PC speed to everyone",
+				"hint": "If enabled the coloring based on actor speed for player characters will shown to everyone, even if they don't have observer permission for the character sheet."
+			},
 			"dashMultiplier": {
 				"name": "Dash Multiplier",
 				"hint": "This can be used to give tokens a secondary speed during coloring of the measured path. Set it to 0 to disable the secondary speed."

module.json

@@ -2,7 +2,7 @@
 	"name": "drag-ruler",
 	"title": "Drag Ruler",
 	"description": "When dragging a token displays a ruler showing how far you've moved that token.",
-	"version": "1.0.1",
+	"version": "1.1.1",
 	"minimumCoreVersion" : "0.7.9",
 	"compatibleCoreVersion" : "0.7.9",
 	"authors": [
@@ -23,7 +23,7 @@
 		}
 	],
 	"url": "https://github.com/manuelVo/foundryvtt-drag-ruler",
-	"download": "https://github.com/manuelVo/foundryvtt-drag-ruler/archive/v1.0.1.zip",
+	"download": "https://github.com/manuelVo/foundryvtt-drag-ruler/archive/v1.1.1.zip",
 	"manifest": "https://raw.githubusercontent.com/manuelVo/foundryvtt-drag-ruler/master/module.json",
 	"readme": "https://github.com/manuelVo/foundryvtt-drag-ruler/blob/master/README.md",
 	"changelog": "https://github.com/manuelVo/foundryvtt-drag-ruler/blob/master/CHANGELOG.md",

src/foundry_imports.js

@@ -44,10 +44,17 @@ async function animateToken(token, rays, tokenOffset, wasPaused) {
 
 	// Determine offset relative to the Token top-left.
 	// This is important so we can position the token relative to the ruler origin for non-1x1 tokens.
-	const origin = canvas.grid.getTopLeft(this.waypoints[0].x + tokenOffset.x, this.waypoints[0].y + tokenOffset.y);
+	origin = canvas.grid.getTopLeft(this.waypoints[0].x + tokenOffset.x, this.waypoints[0].y + tokenOffset.y);
+	let dx, dy
+	if (canvas.grid.type === CONST.GRID_TYPES.GRIDLESS) {
+		dx = token.data.x - origin[0]
+		dy = token.data.y - origin[1]
+	}
+	else {
 		const s2 = canvas.dimensions.size / 2;
-	const dx = Math.round((token.data.x - origin[0]) / s2) * s2;
-	const dy = Math.round((token.data.y - origin[1]) / s2) * s2;
+		dx = Math.round((token.data.x - origin[0]) / s2) * s2;
+		dy = Math.round((token.data.y - origin[1]) / s2) * s2;
+	}
 
 	token._noAnimate = true;
 	for (let r of offsetRays) {
@@ -67,3 +74,24 @@ function calculateTokenOffset(tokenA, tokenB) {
 function applyOffsetToRay(ray, offset) {
 	return new Ray({x: ray.A.x + offset.x, y: ray.A.y + offset.y}, {x: ray.B.x + offset.x, y: ray.B.y + offset.y})
 }
+
+// This is a modified version of Ruler._onMouseMove from foundry 0.7.9
+export function onMouseMove(event) {
+	if (this._state === Ruler.STATES.MOVING) return;
+
+	// Extract event data
+	const mt = event._measureTime || 0;
+	const originalEvent = event.data.originalEvent;
+	const destination = {x: event.data.destination.x + this.rulerOffset.x, y: event.data.destination.y + this.rulerOffset.y}
+
+	// Hide any existing Token HUD
+	canvas.hud.token.clear();
+	delete event.data.hudState;
+
+	// Draw measurement updates
+	if (Date.now() - mt > 50) {
+		this.measure(destination, { gridSpaces: !originalEvent.shiftKey });
+		event._measureTime = Date.now();
+		this._state = Ruler.STATES.MEASURING;
+	}
+}

src/main.js

@@ -1,13 +1,13 @@
 "use strict"
 
 import {availableSpeedProviders, currentSpeedProvider, registerModule, registerSystem, setCurrentSpeedProvider} from "./api.js"
-import {moveTokens} from "./foundry_imports.js"
+import {moveTokens, onMouseMove} from "./foundry_imports.js"
 import {registerSettings, settingsKey} from "./settings.js"
 
 Hooks.once("init", () => {
 	registerSettings()
 	hookTokenDragHandlers()
-	hookRulerHandlers()
+	hookRulerFunctions()
 	patchRulerMeasure()
 	patchRulerHighlightMeasurement()
 
@@ -27,12 +27,14 @@ Hooks.once("ready", () => {
 })
 
 Hooks.on("canvasReady", () => {
-	canvas.controls.ruler.draggedToken = null
-	Object.defineProperty(canvas.controls.ruler, "isDragRuler", {
+	canvas.controls.rulers.children.forEach(ruler => {
+		ruler.draggedToken = null
+		Object.defineProperty(ruler, "isDragRuler", {
 			get: function isDragRuler() {
 				return Boolean(this.draggedToken) // If draggedToken is set this is a drag ruler
 			}
 		})
+	})
 })
 
 function hookTokenDragHandlers() {
@@ -63,7 +65,7 @@ function hookTokenDragHandlers() {
 	}
 }
 
-function hookRulerHandlers() {
+function hookRulerFunctions() {
 	const originalMoveTokenHandler = Ruler.prototype.moveToken
 	Ruler.prototype.moveToken = function (event) {
 		const eventHandled = onRulerMoveToken.call(this, event)
@@ -71,16 +73,36 @@ function hookRulerHandlers() {
 			return originalMoveTokenHandler.call(this, event)
 		return true
 	}
+
+	const originalToJSON = Ruler.prototype.toJSON
+	Ruler.prototype.toJSON = function () {
+		const json = originalToJSON.call(this)
+		if (this.draggedToken)
+			json["draggedToken"] = this.draggedToken.data._id
+		return json
+	}
+
+	const originalUpdate = Ruler.prototype.update
+	Ruler.prototype.update = function (data) {
+		if (data.draggedToken) {
+			this.draggedToken = canvas.tokens.get(data.draggedToken)
+		}
+		originalUpdate.call(this, data)
+	}
 }
 
 function onTokenLeftDragStart(event) {
-	canvas.controls.ruler._onDragStart(event)
 	canvas.controls.ruler.draggedToken = this
+	const tokenCenter = {x: this.x + canvas.grid.size / 2, y: this.y + canvas.grid.size / 2}
+	canvas.controls.ruler.clear();
+	canvas.controls.ruler._state = Ruler.STATES.STARTING;
+	canvas.controls.ruler.rulerOffset = {x: tokenCenter.x - event.data.origin.x, y: tokenCenter.y - event.data.origin.y}
+	canvas.controls.ruler._addWaypoint(tokenCenter);
 }
 
 function onTokenLeftDragMove(event) {
 	if (canvas.controls.ruler.isDragRuler)
-		canvas.controls.ruler._onMouseMove(event)
+		onMouseMove.call(canvas.controls.ruler, event)
 }
 
 function onTokenDragLeftDrop(event) {
@@ -125,10 +147,16 @@ function strInsertAfter(haystack, needle, strToInsert) {
 // These patches were written with foundry-0.7.9.js as reference
 function patchRulerMeasure() {
 	let code = Ruler.prototype.measure.toString()
+	// Replace CRLF with LF in case foundry.js has CRLF for some reason
+	code = code.replace(/\r\n/g, "\n")
 	// Remove function signature and closing curly bracket (those are on the first and last line)
 	code = code.slice(code.indexOf("\n"), code.lastIndexOf("\n"))
 	code = strInsertAfter(code, "for ( let [i, d] of distances.entries() ) {\n", "segments[i].startDistance = totalDistance\n")
 	code = strInsertAfter(code, "this._highlightMeasurement(ray", ", s.startDistance")
+
+	// Don't show ruler if the measured token is invisible
+	code = "if (this.isDragRuler && !this.draggedToken.isVisible) return [];" + code
+
 	Ruler.prototype.measure = new Function("destination", "{gridSpaces=true}={}", code)
 }
 
@@ -150,6 +178,12 @@ function nativeSpeedProvider(token, playercolor) {
 function getColorForDistance(startDistance, subDistance) {
 	if (!this.isDragRuler)
 		return this.color
+	// Don't apply colors if the current user doesn't have at least observer permissions
+	if (this.draggedToken.actor.permission < 2) {
+		// If this is a pc and alwaysShowSpeedForPCs is enabled we show the color anyway
+		if (!(this.draggedToken.actor.data.type === "character" && game.settings.get(settingsKey, "alwaysShowSpeedForPCs")))
+			return this.color
+	}
 	const distance = startDistance + subDistance
 	const ranges = currentSpeedProvider(this.draggedToken, this.color)
 	if (ranges.length === 0)
@@ -165,6 +199,8 @@ function getColorForDistance(startDistance, subDistance) {
 // These patches were written with foundry-0.7.9.js as reference
 function patchRulerHighlightMeasurement() {
 	let code = Ruler.prototype._highlightMeasurement.toString()
+	// Replace CRLF with LF in case foundry.js has CRLF for some reason
+	code = code.replace(/\r\n/g, "\n")
 	// Remove function signature and closing curly bracket (those are on the first and last line)
 	code = code.slice(code.indexOf("\n"), code.lastIndexOf("\n"))
 

src/settings.js

@@ -4,6 +4,15 @@ import {getDefaultDashMultiplier, getDefaultSpeedAttribute} from "./systems.js"
 export const settingsKey = "drag-ruler";
 
 export function registerSettings() {
+	game.settings.register(settingsKey, "alwaysShowSpeedForPCs", {
+		name: "drag-ruler.settings.alwaysShowSpeedForPCs.name",
+		hint: "drag-ruler.settings.alwaysShowSpeedForPCs.hint",
+		scope: "world",
+		config: true,
+		type: Boolean,
+		default: true,
+	})
+
 	// This setting will be modified by the api if modules register to it
 	game.settings.register(settingsKey, "speedProvider", {
 		name: "drag-ruler.settings.speedProvider.name",