rollAddWithLower: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page RollAddWithLower to rollAddWithLower: Converting page titles to lowercase)
No edit summary
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
rollAddWithLower(times, sides, add, minimum)
rollAddWithLower(times, sides, add, minimum)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|times|The number of times to roll the dice.}}
{{param|times|The number of times to roll the dice.}}
Line 16: Line 16:
|examples=
|examples=
Roll five twenty-sided dice. Add 3 to each. Any value now lower than 8 is treated as 8.
Roll five twenty-sided dice. Add 3 to each. Any value now lower than 8 is treated as 8.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[t: rollAddWithLower(5, 20, 3, 8)]
[t: rollAddWithLower(5, 20, 3, 8)]
</source>
</syntaxhighlight>
Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a regular {{code|5d20}} roll).
Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a regular {{code|5d20}} roll).



Revision as of 22:03, 14 March 2023

rollAddWithLower() Function

Generates random numbers to emulate dice rolls. The add parameter is added to each die and all intermediate results that are then lower than the minimum parameter are replaced with that value instead. The total is returned.

Usage

rollAddWithLower(times, sides, add, minimum)

Parameters

  • times - The number of times to roll the dice.
  • sides - The number of sides the dice possess.
  • add - The number to add to each die roll.
  • minimum - The minimum value (after the addition) that each individual die will contribute to the total.

Examples

Roll five twenty-sided dice. Add 3 to each. Any value now lower than 8 is treated as 8.
[t: rollAddWithLower(5, 20, 3, 8)]
Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a regular 5d20 roll).

See Also

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