Module:RankParserDD2/doc

Documentation
RankParserDD2 is a Lua module with two functions,  and , that transform rank specifications into a sequence of ally or enemy dots corresponding to those ranks in Darkest Dungeon II.

A rank specification is a string consisting of a number of the following characters:


 * : indicating that a position is present, i.e. or.
 * : indicating that a position is not present, i.e..
 * : indicating that two positions should be connected, i.e. or.

Be careful! For the sake of performance, the code was written with minimal error-checking and may produce results that are not actually possible in the game! See the following examples for more details.