module

routinglib

Endorsements
0
Installs
4.54%
Comments
0
Latest version1.1.0
Minimum Core
Compatible Core
Last updated10 months ago
Created1 year ago
Authors
Languages
Systems All systems
Project source Project URL
Report bugs Bug tracker URL
Read-me Readme URL
Changelog Changelog URL

Routinglib is a library module that offers pathfinding capabilities to other modules. The code for this library was initially written for the Drag Ruler module and has been extracted into a library to open up the opportunity of using pathfinding to all modules.

 

Should I install this module?

This module does not provide any user-facing features on it's own. Only install this module either if another module you're using has declared this module as a dependency or if another module you're using indicates that it will unlock specific features if routinglib is installed. If neihter of those apply to you, there is nothing to gain by installing routinglib.

 

Capabilities

The following table lists the capabilities and limitations of routinglib with respect to grid types and difficult terrain. Note that you need to install Terrain Ruler if you would like routinglib to take difficult terrain into account.


Using routinglib in a moduleDocumentation on how to use routinglib in your module can be found in the README

  Square or Hex grids Gridless
Without difficult terrain
  • Fast
  • Will always find the shortest possible path, if a path exists
  • Can only calculate paths where each waypoint is snapped to the grid
  • Tokens of even size cannot squeeze through a 1 square hallway
  • Fast on small scenes, slow on scenes with thousands of walls
  • Will find paths that are close to the shortest possible path
  • Tokens aren't able to squeeze through hallways smaller than they are themselves
With difficult terrain
  • Somewhat fast for 1x1 tokens, getting increasingly slower with token size
  • Will always find the shortest possible path, if a path exists
  • Can only calculate paths where each waypoint is snapped to the grid
  • Tokens of even size cannot squeeze through a 1 square hallway
Currently unsupported, terrain will be ignored on gridless scenes

 

Using routinglib in a module

Details on how to use routinglib's pathfinding capabilities in your own module can be fond in the README

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x