clevett / fdp

Dice Parser that handles advanced roll notation for @3d-dice/dice-box

FDP

Fantastic Dice Parser

This module simply provides an interface between @3d-dice/dice-roller-parser and @3d-dice/dice-box. Since dice-roller-parser is a fork of another person's module, I did not want to include this interface in that package.

What it does

This module allows for more advanced rolls with dice-box. All the rolls supported are documented at Roll20 Dice Specification

How to use it

Install the library using:

npm install @3d-dice/fdp

Then create a new instance of dice-roller-parser

import DiceParser from "@3d-dice/fdp";

const DRP = new DiceParser();

The DRP class now has methods to parse raw notations, process re-rolls and compute the final results from dice-box

<form id="dice-to-roll">
  <input
    id="input--notation"
    class="input"
    placeholder="2d20"
    autocomplete="off"
  />
</form>

const form = document.getElementById("dice-to-roll");
const notationInput = document.getElementById("input--notation");

const submitForm = (e) => {
  e.preventDefault();
  const notation = DRP.parseNotation(notationInput.value);
};

form.addEventListener("submit", submitForm);

Methods

parseNotation(string, default: '')

Accepts a dice string input, parses it and returns a JSON representation of the parsed input.

Example: DRP.parseNotation('4d6')

[
  {
    "qty": 4,
    "sides": 6,
    "mods": [],
    "rolls": [
      {
        "sides": 6,
        "groupId": 0,
        "rollId": 0,
        "id": 0,
        "theme": "sunset",
        "result": 1
      },
      {
        "sides": 6,
        "groupId": 0,
        "rollId": 1,
        "id": 1,
        "theme": "sunset",
        "result": 3
      },
      {
        "sides": 6,
        "groupId": 0,
        "rollId": 2,
        "id": 2,
        "theme": "sunset",
        "result": 6
      },
      {
        "sides": 6,
        "groupId": 0,
        "rollId": 3,
        "id": 3,
        "theme": "sunset",
        "result": 6
      }
    ],
    "value": 16
  }
]

See also: Just parse the value

handleRerolls(array, default:[])

This method accepts an array of dice rolls (generated by parseNotation, updated by dice-box) and returns a new array of dice objects that need to be re-rolled. Examples of rolls that could generate rerolls include, exploding, penetrating, and compounding rolls (e.g.: 6d6!). Reroll and reroll-once notation is also supported (e.g.: 2d12r1).

Dice Object:

Property	Type	Description
groupId	int	The group the reroll target belongs to
rollId	int or string	The roll id of the die being rerolled. This will be incremented by .1 for every reroll made
side	int	The number of sides the reroll die has
qty	int	The number of dice to be rolled. This will always be 1 on rerolls but is needed by dice-box

Example:

[
  {
    "groupId": 0,
    "rollId": "2.1",
    "sides": 6,
    "qty": 1
  },
  {
    "groupId": 0,
    "rollId": "3.1",
    "sides": 6,
    "qty": 1
  }
]

parseFinalResults(array, default: [])

After all rolls and rerolls have completed, you can pass the results object to parseFinalResults to get the final results of the dice roll. This typically happens inside dice-box's onRollComplete callback method.

Example:

const results = DRP.parseFinalResults(results);

Putting it all together

Example HTML

Example JavaScript

Caveats

One thing this modules does not do is provide the interface for providing an input for the roll notation string or displaying the final results. It is expected that the developer will create their own inputs and outputs or use modules from @3d-dice/fui

fdp's Issues

rollNotation unused

rollNotation has 0 references

incrementId is mutating variables

incrementId mutates the key passed into it and the array from the split. Fix this.

parseFinalResults dependent on parseNotation

parseFinalResults final results cannot be called unless parseNotation has been called first. There is an error related to null due to this dependancy.

! exploding dice no supported

Dicebox / FDP does not support using ! such as 10d6>5!

updateDieGroups looking for mods on DiceRollResult

mods: obj.mods, but this does not exist on DieGroups

handleRerolls is non-functional

handleRerolls is looking for a mods key which does not appear to be coming back from dice parser.

Fixing Issue #2 will result in rolls values that are NaN

Fixing issue #2 will result in the dice-roller-parser returning NAN as a function.

DiceRoller takes a random function into the constructor. If issue #2 is fixed then its passed a function with a bunch of returns that are NaN.

handleRerolls is not referenced

handleRerolls is not referenced and could be removed

Tests initParser when rolls are not empty

initParser needs tests to check for what happens when this.rollsAsFloats is not empty. This is not set on initialization or by the constructor. Need find a way to test this and its likely impacted by issue #2 and issue #5.

recursiveSearch is using obj[key] causes TS error

Typescript does not like calling objects like this when the key is not specified to be a string. An expect error was added that needs to be removed.

handleRerolls is unused

handleRerolls has no references

parsedNotation is RootType but this incorrect

Dice parser says parsedNotation should be RootType but the types are wrong in the dice roller parser

parseNotation does not take in Theme

parseNotation should take in a roll object for Dicebox which allows for setting themes on dice.

ParserInterface.tets.ts parser.finalResults needs value

Test needs to fix for testing clear. parser.finalResults needs value

updateFloats return NaN[]

updateFloats appears to be incorrectly looping through array/object. Its trying to do math on a string and results in NaN.

recursiveSearch runs recursiveSearch on arrays

recursiveSearch has an else if (value && typeof value === "object") which runs on arrays because an arrray's typefop is "object". This seems like unintended behavior.