json.rolls: Difference between revisions
Jump to navigation
Jump to search
Bubblobill (talk | contribs) (Created page with "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 e.g. {json.rolls("3d6", 6),2} =>...") |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
This function takes 2 or 3 parameters and returns a json array | {{MacroFunction | ||
|name=json.rolls | |||
|proposed=false | |||
|trusted=false | |||
|version=1.4.0.5 | |||
|description= | |||
Rolls the dice expression the requested number of times and returns a JSON Array with the result. This function takes 2 or 3 parameters and returns a json array or an array of arrays if the second dimension is provided. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
json.rolls(roll, dim1) | |||
json.rolls(roll, dim1, dim2) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|roll|A string containing a dice roll expression. The dice expression must be in quotes as shown in the examples.}} | |||
{{param|dim1|The dimension of the returned array.}} | |||
{{param|dim2|Optional: The second dimension for a two dimensional array.}} | |||
''Example:''<syntaxhighlight lang="mtmacro" line> | |||
{json.rolls("3d6", 6)} => [ 11, 7, 15, 8, 10, 13 ] | |||
</syntaxhighlight> | |||
''Example:'' | |||
The three parameter version returns a two dimensional array | The three parameter version returns a two dimensional array | ||
<syntaxhighlight lang="mtmacro" line> | |||
{json.rolls("3d6", 6, 4) | {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 ] ] | ||
</syntaxhighlight> | |||
|also= | |||
[[Introduction to JSON Datatypes ]], {{func|json.objrolls}} | |||
[[Category:JSON Function]] | |||
}} | |||
Latest revision as of 23:59, 15 March 2023
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. This function takes 2 or 3 parameters and returns a json array or an array of arrays if the second dimension is provided.
Usage
json.rolls(roll, dim1)
json.rolls(roll, dim1, dim2)Parameters
roll- A string containing a dice roll expression. The dice expression must be in quotes as shown in the examples.dim1- The dimension of the returned array.dim2- Optional: The second dimension for a two dimensional array.
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 ] ]