json.rolls

From RPTools Wiki
Revision as of 03:45, 1 March 2019 by Azhrei (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

json.rolls() Function

Introduced in version 1.4.0.5
Rolls the dice expression the requested number of times and returns a JSON Array with the result.

Usage

json.rolls(roll, dim1)
json.rolls(roll, dim1, dim2)

Parameters

  • roll - A string containing a dice roll expression.
  • dim1 - The dimension of the returned array.
  • dim2 - Optional: The second dimension for a two dimensional array.

This function takes 2 or 3 parameters and returns a json array json.rolls(roll, dim1, dim2) => returns a json array with the rolls performed

Example:

{json.rolls("3d6", 6)} => [ 11, 7, 15, 8, 10, 13 ]

Example: The three parameter version returns a two dimensional array

{json.rolls("3d6", 6, 4)} => [ [ 11, 13, 11, 13 ], [ 8, 11, 17, 10 ], [ 8, 11, 14, 11 ], [ 6, 8, 13, 6 ], [ 6, 11, 8, 10 ], [ 10, 7, 17, 11 ] ]


See Also