The original provided terms to the Dice Pool
The string modifiers applied to resolve the pool
Each component term of a dice pool is evaluated as a Roll instance
The array of dice pool results which have been rolled
An internal flag for whether the term has been evaluated
An object of additional options which describes and modifies the term.
Is this term intermediate, and should be evaluated first as part of the simplification process?
Define the modifiers that can be used for this particular DiceTerm type.
The regular expression pattern used to identify the opening of a dice pool expression.
A regular expression pattern used to identify the closing of a dice pool expression.
A regular expression pattern used to match the entirety of a DicePool expression.
An array of additional attributes which should be retained when the term is serialized
A regular expression pattern which identifies optional term-level flavor text
A regular expression which identifies term-level flavor text
Return an Array of each individual DiceTerm instances contained within the PoolTerm.
Return an array of rolled values which are still active within the PoolTerm
A string representation of the formula, including optional flavor text.
Optional flavor text which modifies and describes this term.
Alter the DiceTerm by adding or multiplying the number of dice which are rolled
Arguments passed to each contained Roll#alter method.
The altered pool
This method is temporarily factored out in order to provide different behaviors synchronous evaluation. This will be removed in 0.10.x
Evaluate the term.
Options which modify how the RollTerm is evaluated, see RollTerm#evaluate
Use the same logic as for the DiceTerm to avoid duplication
Use the same logic as for the DiceTerm to avoid duplication
Serialize the RollTerm to a JSON string which allows it to be saved in the database or embedded in text. This method should return an object suitable for passing to the JSON.stringify function.
Keep a certain number of highest or lowest dice rolls from the result set.
{1d6,1d8,1d10,1d12}kh2 Keep the 2 best rolls from the pool {1d12,6}kl Keep the lowest result in the pool
The matched modifier query
Keep a certain number of highest or lowest dice rolls from the result set.
{1d6,1d8,1d10,1d12}dl3 Drop the 3 worst results in the pool {1d12,6}dh Drop the highest result in the pool
The matched modifier query
Count the number of successful results which occurred in the pool. Successes are counted relative to some target, or relative to the maximum possible value if no target is given. Applying a count-success modifier to the results re-casts all results to 1 (success) or 0 (failure)
20d20cs Count the number of dice which rolled a 20 20d20cs>10 Count the number of dice which rolled higher than 10 20d20cs<10 Count the number of dice which rolled less than 10
The matched modifier query
Count the number of failed results which occurred in a given result set. Failures are counted relative to some target, or relative to the lowest possible value if no target is given. Applying a count-failures modifier to the results re-casts all results to 1 (failure) or 0 (non-failure)
6d6cf Count the number of dice which rolled a 1 as failures 6d6cf<=3 Count the number of dice which rolled less than 3 as failures 6d6cf>4 Count the number of dice which rolled greater than 4 as failures
The matched modifier query
Evaluate the term, processing its inputs and finalizing its total.
Options which modify how the RollTerm is evaluated
The evaluated RollTerm
Define term-specific logic for how a de-serialized data object is restored as a functional RollTerm
The de-serialized term data
The re-constructed RollTerm object
Given a string formula, create and return an evaluated PoolTerm object
The string formula to parse
The evaluated PoolTerm object or null if the formula is invalid
Construct a RollTerm from a provided data object
Provided data from an un-serialized term
The constructed RollTerm
Reconstruct a RollTerm instance from a provided JSON string
A serialized JSON representation of a DiceTerm
A reconstructed RollTerm from the provided JSON
A type of RollTerm which encloses a pool of multiple inner Rolls which are evaluated jointly.
A dice pool represents a set of Roll expressions which are collectively modified to compute an effective total across all Rolls in the pool. The final total for the pool is defined as the sum over kept rolls, relative to any success count or margin.
Keep the highest of the 3 roll expressions