rollSubWithUpper

From RPTools Wiki
Jump to navigationJump to search

rollSubWithUpper() Function

Generates random numbers to emulate dice rolls. The sub parameter is subtracted from each die and all intermediate results that are then higher than the maximum parameter are replaced with that value instead. The total is returned.

Usage

rollSubWithUpper(times, sides, sub, maximum)

Parameters

  • times - The number of times to roll the dice.
  • sides - The number of sides the dice possess.
  • sub - The number to subtract from each die roll.
  • maximum - The maximum value (after the subtraction) that each individual die can contribute to the total.

Examples

Roll five twenty-sided dice. Subtract 3 from each. Any value now higher than 14 is treated as 14.
[t: rollSubWithUpper(5, 20, 3, 14)]
Returns a number that is between -10 and 70 (and no longer 5 to 100 as with a regular 5d20 roll).

See Also

The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.