# rollWithUpper

Jump to navigation
Jump to search

## rollWithUpper() Function

Generates random numbers to emulate dice rolls. Returns the total of a dice roll where each die that rolled higher than the

`maximum`

parameter is counted as that value instead.### Usage

`rollWithUpper(times, sides, maximum)`

**Parameters**

`times`

- The number of times to roll the dice.`sides`

- The number of sides the dice possess.`maximum`

- The maximum value that each individual die can contribute to the total.

### Examples

Roll five twenty-sided dice. Any rolls above 16 are treated as 16.
Returns a number that is between 5 and 80 (and no longer up to 100 as with a regular

`[t: rollWithUpper(5, 20, 16)]`

`5d20`

roll).### See Also

The corresponding dice roll expression is

`XdYuZ`

. For other methods of rolling dice, see Dice Expressions.