Dice Reference - Revision history

Skizzerz: add implode extras

2021-07-08T23:55:16Z

add implode extras

Skizzerz: /* Macros */ add numDice

2018-12-23T18:15:58Z

Macros: add numDice

Skizzerz: /* Dice functions */

2017-08-11T17:19:51Z

Dice functions

Skizzerz: /* if */

2017-04-19T16:26:10Z

Skizzerz: /* Global functions */ +if

2017-04-19T16:14:28Z

Global functions: +if

Skizzerz: /* roll */

2017-04-19T16:06:36Z

roll

Skizzerz: /* Macros */

2017-04-19T16:05:26Z

Macros

Skizzerz: /* Dice functions */

2017-04-18T19:01:12Z

Dice functions

Skizzerz: /* Reroll (Basic) */ can now be group

2017-04-18T19:00:53Z

Reroll (Basic): can now be group

Skizzerz: /* Dice functions */

2017-04-14T22:51:47Z

Dice functions

@@ Line 106: / Line 106: @@
 ; {{c|!e{{p|C}}}}
 : Whenever the comparison succeeds for a die, that die is rerolled. Both the original and reroll are added to the total. This repeats until the comparison fails.
 ; {{c|!c}}
 : Per {{c|!e}}, except that the rerolled values are added to the original die result, rather than adding another die into the final result list. This is called a compounding explosion. For example, {{c|1d6!c}} would roll 1d6. If a 6 is rolled, another 1d6 is rolled, and so on. This could lead to a final roll of 6, 6, 4, which is represented by a single 6-sided die rolling a value of 16.
@@ Line 114: / Line 118: @@
 ; {{c|!p{{p|C}}}}
 : Per {{c|!p}}, except it compares the die result against the comparison C instead of using the maximum value of the die. Furthermore, the special downgrading rules are not used, so d100 will penetrate to d100, and d20 will penetrate to d20.
 === Reroll (Basic/Group) ===

@@ Line 28: / Line 28: @@
 * {{c|1d20+[WIS-mod]}} (rolls 1d20 and adds the result of the WIS-mod macro)
 * {{c|1d10+[SneakAttack]d6}} (rolls 1d10 plus a number of d6's equal to the SneakAttack macro)
 === Play-by-Post Macros ===

← Older revision		Revision as of 17:19, 11 August 2017
Line 298:		Line 298:

	This is equal to specifying the {{c\|sd}} extra.		This is equal to specifying the {{c\|sd}} extra.
		+
		+	=== expand (Group) ===
		+	{{c\|.expand()}}
		+
		+	Normally, grouped rolls display aggregated results instead of showing the value of each individual die rolled. For example, {{c\|<nowiki>{4d6}</nowiki>}} will display (for example) {{c\|(15)}} instead of {{c\|(4 + 5 + 3 + 3)}}. The expand function causes it to display the value of each individual die instead, so {{c\|<nowiki>{4d6}.expand()</nowiki>}} will display (for example) {{c\|(4 + 5 + 3 + 3)}}. Expand is applied before sorting, so you can sort the individual rolls of a group if you both expand and sort.

@@ Line 192: / Line 192: @@
 === if ===
 ; {{c|if({{p|E<sub>1</sub>}}, {{p|C}}, {{P|E<sub>2</sub>}})}}
-: If the comparison succeeds for E<sub>1</sub>, then this evaluates and returns the Value of E<sub>2</sub>. Otherwise, this returns 0.
+: If the comparison succeeds for E<sub>1</sub>, then this returns the Value of E<sub>2</sub>. Otherwise, this returns 0.
 ; {{c|if({{p|E<sub>1</sub>}}, {{p|C}}, {{P|E<sub>2</sub>}}, {{p|E<sub>3</sub>}})}}
-: If the comparison succeeds for E<sub>1</sub>, then this evaluates and returns the Value of E<sub>2</sub>. Otherwise, this evaluates and returns the Value of E<sub>3</sub>.
+: If the comparison succeeds for E<sub>1</sub>, then this returns the Value of E<sub>2</sub>. Otherwise, this returns the Value of E<sub>3</sub>.
 == Dice functions ==

← Older revision		Revision as of 16:14, 19 April 2017
Line 189:		Line 189:

	Returns the lowest Value from the two expressions. Dice rolled in the high-valued expression are all marked as dropped.		Returns the lowest Value from the two expressions. Dice rolled in the high-valued expression are all marked as dropped.
		+
		+	=== if ===
		+	; {{c\|if({{p\|E<sub>1</sub>}}, {{p\|C}}, {{P\|E<sub>2</sub>}})}}
		+	: If the comparison succeeds for E<sub>1</sub>, then this evaluates and returns the Value of E<sub>2</sub>. Otherwise, this returns 0.
		+
		+	; {{c\|if({{p\|E<sub>1</sub>}}, {{p\|C}}, {{P\|E<sub>2</sub>}}, {{p\|E<sub>3</sub>}})}}
		+	: If the comparison succeeds for E<sub>1</sub>, then this evaluates and returns the Value of E<sub>2</sub>. Otherwise, this evaluates and returns the Value of E<sub>3</sub>.

	== Dice functions ==		== Dice functions ==

@@ Line 56: / Line 56: @@
 : Counts the number of dice in the Xth roll that were marked as successes.
-; {{c|[roll:{{p|X}}:{{p|Y}}:fumble]}}
+; {{c|[roll:{{p|X}}:{{p|Y}}:success]}}
 : This is 1 if the Yth die in the Xth roll is a success, and 0 otherwise.
@@ Line 62: / Line 62: @@
 : Counts the number of dice in the Xth roll that were marked as failures.
-; {{c|[roll:{{p|X}}:{{p|Y}}:fumble]}}
+; {{c|[roll:{{p|X}}:{{p|Y}}:failure]}}
 : This is 1 if the Yth die in the Xth roll is a failure, and 0 otherwise.

@@ Line 23: / Line 23: @@
 == Macros ==
-Whenever a number is expected, a macro can be provided instead. The DiceRoller library does not define any macros itself, but the program which uses the library may define custom macros. Macros are enclosed in square brackets, and can have any text inside of them (except for more square brackets, curly braces, or parenthesis). An example of a macro may be something that looks up a property on a character sheet, but the possibilities are unlimited.
+Whenever a number is expected, a macro can be provided instead. The stand-alone dice roller does not define any macros, but the Play-by-Post helper utility defines some (see below for more details). Additionally, the program which uses the library may define custom macros. Macros are enclosed in square brackets, and can have any text inside of them (except for a right square bracket). An example of a macro may be something that looks up a property on a character sheet, but the possibilities are unlimited.
 Examples of macros:
 * {{c|1d20+[WIS-mod]}} (rolls 1d20 and adds the result of the WIS-mod macro)
 * {{c|1d10+[SneakAttack]d6}} (rolls 1d10 plus a number of d6's equal to the SneakAttack macro)
 == Grouped rolls ==

@@ Line 159: / Line 159: @@
 If a function is marked with (Basic) it can be used with basic rolls, and if it is marked with (Group) it can be used with group rolls. Those marked (Basic/Group) can be used with both types of rolls. If the function takes a parameter, it will indicate if it takes a number {{p|N}}, an expression {{p|E}} (which can be any arbitrary math or roll expression), or an explicit comparison {{p|C}}. Should a function take a number as a parameter, it must either be a literal number or a macro, it cannot contain any rolls or math.
-=== reroll (Basic) ===
+=== reroll (Basic/Group) ===
 {{c|.reroll({{p|C}}, {{p|C}}, {{p|...}})}}
 This is equal to specifying the {{c|rr}} extra once for each comparison passed into the function. At least one comparison must be specified. For example, to reroll 1d6 whenever an even number comes up, you could specify {{c|1=1d6.reroll(=2, =4, =6)}}.
-=== rerollN (Basic) ===
+=== rerollN (Basic/Group) ===
 {{c|.rerollN({{p|N}}, {{p|C}}, {{p|C}}, {{p|...}})}}
 Like reroll, however will only reroll at most N times before it keeps the final result (even if one of the comparisons would still succeed). At least one comparison must be specified.
-=== rerollOnce (Basic) ===
+=== rerollOnce (Basic/Group) ===
 {{c|.rerollOnce({{p|C}}, {{p|C}}, {{p|...}})}}

@@ Line 73: / Line 73: @@
 : Per {{c|!p}}, except it compares the die result against the comparison C instead of using the maximum value of the die. Furthermore, the special downgrading rules are not used, so d100 will penetrate to d100, and d20 will penetrate to d20.
-=== Reroll (Basic) ===
+=== Reroll (Basic/Group) ===
 ; {{c|rr{{p|C}}}}
 : Whenever the comparison succeeds, it rerolls the die, discarding the previous result. This will happen until the comparison fails.

@@ Line 244: / Line 244: @@
 This is equal to specifying the {{c|cf}} extra once for each comparison passed into the function. At least one comparison must be specified.
-=== sortasc (Basic/Group) ===
+=== sortAsc (Basic/Group) ===
-{{c|.sortasc()}}
+{{c|.sortAsc()}}
 This is equal to specifying the {{c|sa}} extra.
-=== sortdesc (Basic/Group) ===
+=== sortDesc (Basic/Group) ===
-{{c|.sortdesc()}}
+{{c|.sortDesc()}}
 This is equal to specifying the {{c|sd}} extra.