Added Brazilian translation. Thanks @Kharmans! Added Russian translation. Thanks @VirusNik21! Closes #96. Added Polish translation. Thanks @Lioheart! Closes #94. Added setting to hide the GM ruler. Thanks @Mystler! Closes #86.
Fix snapping of small tokens when using Token Ruler. Closes #70, #95. Fix error re invalid elevation when adjusting elevation with the ruler. Closes #84, #92. Add separate add/remove waypoint keybindings for regular ruler vs token ruler. Handle right-clicking to add a waypoint (hold control to remove). Closes #99, #80 Fix compatibility with Terrain Mapper. Refactor how elevation changes work. Now incrementing/decrementing elevation changes the elevation from the last waypoint. Allows tokens to maneuver over/under regions. Closes #100. Requires Terrain Mapper v0.3.2.
Remove custom unsnap code now that v12's Ruler allows unsnapping properly.
Fix for displaying colors to other users (from v0.8.13).
Fix definitions of the add/remove waypoint key modifiers.
Improve placement of tokens when dragging with the Token Ruler.
Fix for tracking arrow-key movement of tokens for combat history. Issue #74.
Set pathfinding to default to "on." Issue #73.
Fix error when broadcasting ruler elevation changes.
Round elevation to nearest multiple.
Add setting for hiding speed highlighting for hostiles (from v0.8.13). Add setting for using speed highlighting only during combat (from v0.8.13).
Fix for speed color error.
Fix pathfinding.
Change the keybind for teleport to "F" (fast-forward) to avoid collision with arrow-key usage on the canvas. Switch to requiring "F" to be held when the user triggers the move to get teleport, to avoid weirdness with the drag still being active when using a separate trigger key.
Catch error if waypoint is not added in _addWaypoint.
Correct error when sending ruler data from one user to another.
Move Maximum speed category to CONFIG.elevationruler.SPEED.CATEGORIES. Should now be possible to define specific colors per user in the CONFIG, so long as category names are same.
Fix errors when using the ruler on gridless scenes. Correct speed highlighting on gridless scenes.
Add a configuration option (CONFIG.elevationruler.gridlessHighlightWidthMultiplier) to adjust the width of the gridless highlight.
Add a "teleport" keybind and associated Ruler.prototype.method. If a ruler is active, this will set all segments to "teleport" and will jump to any user-set waypoints and then the destination, very quickly.
Initial support for Foundry v12.
Pathfinding does not work. Error at startup canvas.walls.outerBounds is not iterable is related to pathfinding but can be otherwise ignored.
Add support from dragonbane and twodsix systems from v12 branch. Update speed category handling to match v12 branch. Fix for speed colors not properly displaying between users. Change setting for using speed highlighting to allow it to display only during combat.
Fix for speed highlighting not working if the Token HUD has not been used. Closes #65.
Add a keybinding ("g") to force the ruler to measure from ground terrain. Replaces "Prefer Token Elevation," which was removed. Closes #63, #64.
Catch when a segment color is not defined, to avoid throwing an error. Fix for incorrect combat speed movement highlighting after the first move. Closes #62.
Add indicator of past combat movement in the ruler.
Allow for unlimited number of speed categories, colors, along with custom speed functions in the CONFIG. Closes issue #58.
More aggressive path straightening using a reverse Ramer-Douglas-Peucker algorithm based on collision checking. Closes issue #48.
Add CONFIG settings to ignore tokens for pathfinding based on HP attribute or set of token statuses. Closes issue #55.
Add a keybind ("p") to temporarily toggle pathfinding.
Add rulerSegmentOrigin and rulerSegmentDestination to options passed to token update.
Refactor physical and move distance measurement in anticipation of Foundry v12. Closes issue #59 (measurement near waypoints). Refactor how segments are split for purposes of speed highlighting. Fix for counting alternating diagonals across ruler segments/waypoints. Fix for token stopping prematurely if the mouse is released after space bar pressed when using the Ruler. Fix for "drunken token movement" in which a token would wander off the path when moving through several fake waypoints that were not centered on the grid. Allow large tokens to move through triangle edge unless both vertices of the edge shares a blocking edge. This allows pathfinding to work for large tokens in more situations, while still not taking paths through narrow spaces constrained on both sides by walls.
Options for CONFIG.elevationruler.SPEED have changed. To change the speed highlighting, you will need to change the array of speed categories in CONFIG.elevationruler.SPEED.CATEGORIES. A speed category is defined as:
/**
* @typedef {object} SpeedCategory
*
* Object that stores the name, multiplier, and color of a given speed category.
* Custom properties are permitted. The SpeedCategory is passed to SPEED.maximumCategoryDistance,
* which in turn can be defined to use custom properties to calculate the maximum distance for the category.
*
* @prop {Color} color Color used with ruler highlighting
* @prop {string} name Unique name of the category (relative to other SpeedCategories)
* @prop {number} [multiplier] This times the token movement equals the distance for this category
*/For more complex options, you can now replace two functions that control token speed measurements. You may also want to add additional properties to the SpeedCategory for your use case.
/**
* Given a token, get the maximum distance the token can travel for a given type.
* Distance measured from 0, so types overlap. E.g.
* WALK (x1): Token speed 25, distance = 25.
* DASH (x2): Token speed 25, distance = 50.
*
* @param {Token} token Token whose speed should be used
* @param {SpeedCategory} speedCategory Category for which the maximum distance is desired
* @param {number} [tokenSpeed] Optional token speed to avoid repeated lookups
* @returns {number}
*/
SPEED.maximumCategoryDistance = function(token, speedCategory, tokenSpeed) {
tokenSpeed ??= SPEED.tokenSpeed(token);
return speedCategory.multiplier * tokenSpeed;
};
/**
* Given a token, retrieve its base speed.
* @param {Token} token Token whose speed is required
* @returns {number} Distance, in grid units
*/
SPEED.tokenSpeed = function(token) {
const speedAttribute = SPEED.ATTRIBUTES[token.movementType] ?? SPEED.ATTRIBUTES.WALK;
return Number(foundry.utils.getProperty(token, speedAttribute));
};Track combat moves on a per-combat basis. Add settings toggle to have movement speed highlighting reflect sum of moves for that combat round.
Fix errors thrown when using the ruler without a movement token with either Terrain Mapper or Elevated Vision modules active. Closes issue #51. Display speed colors to other users who have the speed color setting enabled. Closes issue #53. Add CONFIG options to set additional movement types to the token hud. Closes issue #50.
// Example: Add a swim movement to the api.
CONFIG.elevationruler.MOVEMENT_TYPES.SWIM = 3; // Increment by 1 from the highest-valued movement type
CONFIG.elevationruler.MOVEMENT_BUTTONS[CONFIG.elevationruler.MOVEMENT_TYPES.SWIM] = "person-swimming"; // From Font Awesome
CONFIG.elevationruler.SPEED.ATTRIBUTES.SWIM = "actor.system.attributes.movement.swim"; // dnd5eImprovements to updating the scene graph. Avoid leaving unneeded vertices and split edges when a token or wall is removed. Fixes to handling overlapping edges to correctly reflect what objects make up the edge.
Update lib geometry to v0.2.18.
GM can now set whether pathfinding should be limited for users to areas within the fog of war. FYI, testing fog of war in Foundry for canvas positions is a performance hit. Closes issue #47.
Take the starting elevation of the path when testing whether tokens or walls block the path. Allows tokens or limited height walls to be ignored if no collision at the given elevation.
Fix for measuring elevation when Elevated Vision module is enabled. Closes issue #45.
Fix for pathfinding slipping through small cracks between walls. Unless the wall is a door, the path should be limited to half the token min(width, height).
Added settings for selecting how terrain and other tokens are measured for grid squares. GM can choose to count difficult terrain if it covers the grid center, covers a fixed percentage of a grid square/hex, or by the percent for which it overlaps a line between the previous grid shape center to the current grid shape center ("euclidean").
Added selection in Drawings to treat a drawing as imposing a move bonus/penalty. May be changed or dropped to accommodate Foundry v12 scene regions in the future.
Fix for the token apparent position disconnecting from actual token position when dragging or moving token with the ruler.
Fix for undefined constrainedTokenBounds.contains. Closes issue #46.
Fix for highlighting incorrect squares with high elevation changes.
Refactor (again!) measurement of distances and move distances. Addresses issues with movement measurement calculating incorrectly when speed highlighting adds temporary waypoints.
Update lib geometry to v0.2.17.
Improve path cleaning algorithm to remove multiple straight-line points. Closes issue #40.
Refactor measurement of distances and move distances to better account for 3d distance. Closes issue #41.
Remove animation easing for intermediate segments while keeping easing-in for the first segment and easing-out for the last segment.
Add CONFIG settings to change the unicode symbol displayed when the ruler is over terrain (or tokens, if tokens count as difficult terrain).
CONFIG.elevationruler.SPEED.terrainSymbol: You can use any text string here. Paste in a unicode symbol if you want a different symbol. For Font Awesome icons, use, e.g., "\uf0e7".CONFIG.elevationruler.SPEED.useFontAwesome: Set to true to interpet theterrainSymbolas FA unicode. Update lib geometry to v0.2.15.
The added methods Ruler.measureDistance and Ruler.measureMoveDistance were refactored and now take different parameters.
Add setting for pathfinder to avoid all tokens or hostile tokens. Closes issue #37. Misc. fixes to pathfinding to reduce likelihood of it failing to find a path or finding an incorrect path. Fix for waypoint elevations not finite. Closes issue #38. Refactor of elevation handling to account for Token Ruler tokens versus primary ruler.
Add selector to Token HUD to choose between walk/fly/burrow movement types. Default is to automatically choose based on elevation. Closes issue #33.
Move settings related to speed properties to CONFIG.elevationruler.SPEED.
Add getter Token.prototype.lastMoveDistance that tracks the last token move. If combat is active, this returns 0 if the token has not yet moved this round. Use Token.prototype._lastMoveDistance to find the actual last distance moved regardless of combat.
Add setting to round ruler measurements, for use with gridless scenes. Thanks @Larkinabout for the PR!
Improvements to calculating distance on a grid. Improvements to splitting ruler segments when highlighting based on token speed. Closes issue #35. Improvements to treating tokens as difficult terrain for purposes of token speed highlighting.
Added a "hiking boot" displaying token movement distance in the ruler when difficult terrain is encountered (tokens or from Terrain Mapper module).
Fix toggling pathfinding between waypoints.
Various fixes to display of ruler for other users.
Fixes for display of distance calculations between waypoints.
Possible fix for issue #33 (undefined token.bounds).
Added pathfinding toggle. Pathfinding works on gridded (both hex and square) and gridless maps. Works when dragging tokens, if Token Ruler is enabled, or when using the Ruler control and you start at a token.
To benchmark pathfinding in a scene:
api = game.modules.get("elevationruler").api;
api.pathfinding.benchPathfinding()Refactored movement highlighting to work better with pathfinding.
More tweaks to how token origin and destination are set when dragging so that the token movement follows the position of the cloned dragged token. Revisits issue #30. Fix issue where token dragging cannot move to the adjacent space. Closes issue #32.
Allow GM to move tokens using the ruler regardless of obstacle. Closes issue #27. Cancel the ruler when canceling the drag. Closes issue #28. Add setting to treat tokens as difficult terrain. Closes issue #29. Force the ruler to use the center of the (dragged) token. Closes issue #30. Fix error message re setting when using Levels. Closes issue #31.
Fix incorrect Ruler.js import. Closes issue #26.
Fix for pause/unpause game not working due to conflict with token move using spacebar. Add handling for unsnapping from the grid. If shift is held, unsnap ruler waypoints and destination. If measuring from a token, set the origin point of the ruler to the (possibly unsnapped) token center. Fix incorrect case on Ruler.js. Closes issue #25.
Add option to enable a Token Ruler when dragging tokens. Add option to use a token speed attribute to highlight in differing colors when using the ruler (from a token) or dragging tokens.
Updated lib-geometry to 0.2.12. Refactor to use Patcher class.
Updated lib-geometry to 0.2.2.
Updated lib-geometry to 0.2.1.
Updated for Foundry v11. Updated lib-geometry to 0.2.0.
- Store the active/inactive status of the "prefer token elevation" toggle so it is consistent when switching scenes or reloading Foundry (issue #19).
- Improvements to the logic for measuring overhead tile elevations and terrain elevations when Elevated Vision module is active (issue #18).
- Fix measuring elevation with Elevated Vision enabled (issue #18).
- No longer require reload of the canvas when enabling/disabling prefer token control.
- Prefer token control now remembers its current setting (enabled/disabled) when switching back-and-forth between layers
Update geometry lib to v0.1.5. Fix for incorrect diagonal measurement in grids (issue #3). Issue with dnd5e may still result in questionable rounded values when measuring Euclidean distances and 5/10/5 measurements on hex maps. See foundryvtt/dnd5e#2257 and foundryvtt/dnd5e#2256. Fix for updating ruler elevation label on gridless maps when increasing or decreasing elevation. Fix for measuring elevation for terrains created by Enhanced Terrain Elevation (issues #8, #15).
Update geometry lib to v0.1.4.
Update geometry lib to v0.1.3. Fix for calculating total distance in the vertical and horizontal directions (dx or dy equal 0). Possibly fixes issue #14. Add up/down arrow for label when elevation is unchanged, and move arrow to front of label.
Update geometry lib to v0.1.1. Add options to display Levels floor labels always/never/only when Levels UI is active. (Issue #12). Fix for description of the key control to increase ruler increments. (Issue #13).
Use shared geometry lib git submodule.
Fix ruler calculation so the combined elevation distance and 2d distance is shown. (Closes issue #11.)
Drag Ruler compatibility! Some under-the-hood changes extending Ray to a Ray3d class to make segment distance measurements easier to accomplish.
Fix issue #1 (Ruler updating for other users)
Foundry v10 compatibility. v9 only supported in 0.4 versions. Due to various improvements in Foundry v10 Ruler class, libRuler is now deprecated; only libWrapper is required as a dependency.
- Updated Levels module support.
- Updated code for Enhanced Terrain module but a bug with that module is preventing testing.
- Added Elevated Vision module support.
Foundry v10 testing.
Require Foundry v9; replace df-hotkeys module dependency with Foundry keybindings.
Fix issue #5 (levels_data undefined).
Fix repeated warnings when using devMode for logging. Call the libRuler distance function when projecting on a grid, to accommodate modules that might modify the distance function.
Correct module.json link to DragonFlagon Hotkeys Library.
Move to libRuler 0.1 compatibility. Improvements:
- Wraps libRuler RulerUtilities functions to 3d versions:
iterateGridUnderLine,calculateDistance,pointsAlmostEqual. - Adds user setting to prefer the starting token elevation when measuring.
- Revamps the projection from 3-D to 2-D to account for specific grid types and diagonal rules. This should more closely correspond to user expectations concerning vertical movement in a grid.
Breaking changes due to libRuler changes:
- Relies on the libRuler RulerUtilities functions
Correct "jumping token" issue where when the token is moved, it will appear to drift off the path and move twice.
For conceptual consistency, switch to projecting the origin point for the token so that the projected path goes from the token at a given height to the destination point. This was the intended approach, but the origin/destination got flipped in the projection code. May not result in a different outcome in most cases, but may be different for edge cases when measuring diagonals.
Minor update with additional checks on presence of elevation increment flag. Additional logging.
Fix #3. When a grid is present, snap the projected destination point to the center of the grid. This keeps the distances consistent for different cardinalities. Rounding still occurs with grid measurements such that adjacent squares may have the same measured 3-D distance despite appearing to be closer/further from the origin point.
Update manifest for libruler dependency to point to correct JSON URL. Fixes #2.
Catch when no Levels tiles are present under the ruler position, so that Levels floor labels do not appear unnecessarily.
Add levels measurement function
- When over a levels tile, default to the bottom elevation of that tile.
- When over a levels hole, default to the bottom elevation of that hole.
- When starting at a token, stay at the floor level for that token unless over a hole or other token.
- Optional label for the current floor level.
Switch to using
canvas.terrain.terrainsFromPixels(requires Enhanced Terrain Layer 1.0.30+).
Catch case where game.users.isGM is undefined.
Update the module.json to use a name without special characters to conform to Foundry requirements. Update Foundry compatibility to 0.8.8.
Correct display of negative current elevation in ruler.
Add terrain measurement feature.
- Use destination token elevation to automatically change ruler elevation.
- Use Enhanced Terrain Layer to automatically change ruler elevation.
- Change ruler display to show elevation change and current elevation at each waypoint.
Add compatibility for libRuler 0.0.5.
- Address the change to physical path (Object instead of Array).
Add compatibility for Foundry 0.8.5.
- Change updating of the token elevation to use the Document class.
Incorporate previous segments change from libRuler.
- Add a flag to track when any segment has an elevation change, for labeling.
- Correct elevation measurement by switching to grid units for the elevation points.
- Label total elevation using absolute value (arrow signifies up or down).
Incorporate libRuler and various improvements.
- Add flags to each Segment to track elevation during measurement.
- Change elevation on the moved token.
- Correct issue with displaying hotkey in the preferences for Elevation Ruler.
Basic functionality to increment/decrement elevation using the default Foundry ruler.
- Track elevation changes in the ruler.
- Allow user to select a hotkey DF Hotkeys module to add or subtract elevation.
- Display the elevation change once changed by the user
- Track and display elevation change across waypoints.
- Display elevation changes to other users.