website·Indexed 31 days ago
https://dice-roller.github.io/documentation/A library for handling dice rolling functionality, including support for various dice types like StandardDice, PercentileDice, and FudgeDice. It features a comprehensive system for dice notations, roll history, and modifiers such as KeepModifier, DropModifier, ExplodeModifier, and CriticalSuccessModifier. The documentation covers API references for RollResults, custom random number generators, and a CLI for direct command-line usage.
Parser is a global class that takes a dice notation string and parses it into a list of dice and modifier objects. While it is used internally by the DiceRoll object, it can be used independently to validate or decompose notation strings.CriticalSuccessModifier is a global class that extends ComparisonModifier. Unlike most modifiers, it does not alter the roll value; instead, it flags rolls that match a specific comparison point. For the opposite behavior, use CriticalFailureModifier.CriticalFailureModifier is a global class used to flag roll values that match a specific comparison. Unlike most other modifiers, it does not change the roll value; it only marks the roll as a critical failure based on the provided ComparePoint.MinModifier class (extending Modifier) ensures that any die rolls falling below a specified minimum value are treated as that minimum value. It has been available since version 4.3.0.ReRollModifier class (which extends ComparisonModifier) re-rolls dice that match a given test and replaces the old value with the new one. If you need to keep the old value in addition to the new roll, use ExplodeModifier instead.CriticalSuccessModifier is a global class that extends ComparisonModifier. It is used to flag roll values that match a specific comparison. Unlike most other modifiers, it does not change the roll's numerical value; it only marks the roll as a critical success.ExplodeModifier is a global class that extends ComparisonModifier. It re-rolls dice that match a given test (defined by a ComparePoint) and adds the new results to the existing roll results. If you need to replace the original value with the new roll instead of adding to it, use ReRollModifier instead.MaxModifier class ensures that any die roll exceeding a specified maximum value is treated as that maximum value. It extends the Modifier class and has been available since version 4.3.0.KeepModifier class allows you to specify a number of dice to keep from a roll, effectively dropping all other results from the total calculation. You can choose to keep either the highest ('h') or lowest ('l') values.