dropHighest

From RPTools Wiki
Revision as of 17:08, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

dropHighest() Function

Introduced in version 1.5.2
Generates random numbers to emulate dice rolls; returns the total of a dice roll that ignores a certain number of the highest dice rolled.

Usage

<source lang="mtmacro" line> dropHighest(times, sides, ignore) </syntaxhighlight> Parameters

  • times - The number of times to roll the dice.
  • sides - The number of sides the dice possess.
  • ignore - The number of highest rolls that are ignored when totaling the roll.

Examples

Roll ten twenty-sided dice, ignoring the highest five rolls.

<source lang="mtmacro" line> [t: dropHighest(10, 20, 5)] </syntaxhighlight> Returns a number that is between 5 and 100, with a low average.

Roll five ten-sided dice ignoring the highest two rolls, using variables. <source lang="mtmacro" line> [h: DiceTimes = 5] [h: DiceSides = 10] [h: DiceIgnore = 2] [t: dropHighest(DiceTimes, DiceSides, DiceIgnore)] </syntaxhighlight>

Returns a number than is between 3 and 30, with a low average.

See Also

For another method of rolling dice, see Dice Expressions.

Version Changes

  • 1.5.2 - Introduced