countsuccess

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

countsuccess() Function

Generates random numbers to emulate dice rolls; returns the count of dice rolls that are above a certain target number.

Usage

<source lang="mtmacro" line> countsuccess(times, sides, target) </syntaxhighlight> <source lang="mtmacro" line> success(times, sides, target) </syntaxhighlight> Parameters

  • times - The number of times to roll the dice.
  • sides - The number of sides the dice possess.
  • target - The number that a dice needs to be equal to or higher to be considered a success.

Examples

Roll twenty ten-sided dice, and return the number that are above five.

<source lang="mtmacro" line> [t: countsuccess(20, 10, 5)] </syntaxhighlight> Returns a number that is between 0 and 20, which is the number of dice that rolled higher than 5.

Roll twelve six-sided dice, and return the number that are above three, using variables. <source lang="mtmacro" line> [h: DiceTimes = 12] [h: DiceSides = 6] [h: DiceSuccess = 3] [t: countsuccess(DiceTimes, DiceSides, DiceSuccess)] </syntaxhighlight>

Returns a number than is between 0 and 12, which is the number of dice that rolled higher than 3.

See Also

For another method of rolling dice, see Dice Expressions.