openTest: Difference between revisions
Jump to navigation
Jump to search
(Needs clarification) |
(Add reference to explodingSuccess) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
|name=openTest | |name=openTest | ||
|description= | |description= | ||
Rolls a number of dice of requested side with exploding rolls and returns a formatted string containing the result of each roll and the highest value produced. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
openTest(times, sides) | openTest(times, sides) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|times|The number of times to roll the dice.}} | {{param|times|The number of times to roll the dice.}} | ||
| Line 14: | Line 14: | ||
|examples= | |examples= | ||
Roll five ten-sided dice. | Roll five ten-sided dice. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[t: | [t: openTest(5, 10)] | ||
</ | </syntaxhighlight> | ||
Returns a string that is similar to {{code|Dice: 5, 4, 19, 6, 3, Maximum: 19}} | Returns a string that is similar to {{code|Dice: 5, 4, 19, 6, 3, Maximum: 19}} | ||
Roll five ten-sided dice, using variables. | Roll five ten-sided dice, using variables. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: DiceTimes = 5] | [h: DiceTimes = 5] | ||
[h: DiceSides = 10] | [h: DiceSides = 10] | ||
[t: | [t: openTest(DiceTimes, DiceSides)] | ||
</ | </syntaxhighlight> | ||
Returns a string that is similar to {{code|Dice: 5, 4, 19, 6, 3, Maximum: 19}} | Returns a string that is similar to {{code|Dice: 5, 4, 19, 6, 3, Maximum: 19}} | ||
|also= | |also= | ||
For another method of rolling dice, see [[Dice Expressions]]. | For another method of rolling dice, see [[Dice Expressions]].<br> | ||
For a similar function that returns the number of successes instead of the highest roll, see [[explodingSuccess]]. | |||
}} | }} | ||
[[Category:Dice Function]] | [[Category:Dice Function]] | ||
Latest revision as of 23:59, 1 August 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Better explanation, perhaps examples on how to strip out the dice rolls from the string that is returned.
openTest() Function
Rolls a number of dice of requested side with exploding rolls and returns a formatted string containing the result of each roll and the highest value produced.
Usage
openTest(times, sides)Parameters
times- The number of times to roll the dice.sides- The number of sides the dice possess.
Examples
Roll five ten-sided dice.
Returns a string that is similar to
[t: openTest(5, 10)]Returns a string that is similar to Dice: 5, 4, 19, 6, 3, Maximum: 19
Roll five ten-sided dice, using variables.
[h: DiceTimes = 5]
[h: DiceSides = 10]
[t: openTest(DiceTimes, DiceSides)]Dice: 5, 4, 19, 6, 3, Maximum: 19See Also
For another method of rolling dice, see Dice Expressions.
For a similar function that returns the number of successes instead of the highest roll, see explodingSuccess.
For a similar function that returns the number of successes instead of the highest roll, see explodingSuccess.