clearRolls: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page ClearRolls to clearRolls: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 9: Line 9:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
clearRolls()
clearRolls()
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|none|Takes no parameters.}}
{{param|none|Takes no parameters.}}
Line 27: Line 27:
Get New Rolls: [r: getNewRolls()]<br>
Get New Rolls: [r: getNewRolls()]<br>
Get Rolled: [r: getRolled()]<br>
Get Rolled: [r: getRolled()]<br>
</source>
</syntaxhighlight>


'''Output:'''
'''Output:'''
Line 42: Line 42:
Get New Rolls: [2,2,4]
Get New Rolls: [2,2,4]
Get Rolled: [2,2,4]
Get Rolled: [2,2,4]
</source>
</syntaxhighlight>


|also=
|also=

Revision as of 16:59, 14 March 2023

clearRolls() Function

Introduced in version 1.5.2
Clears the internal array that keeps track of the individual dice rolls for the current macro.

Usage

<source lang="mtmacro" line> clearRolls() </syntaxhighlight> Parameters

  • none - Takes no parameters.

Example

Clear the saved rolls after second time.

<source lang="mtmacro" line> Roll 3d6: [e: 3D6]
Get New Rolls: [r: getNewRolls()]
Get Rolled: [r: getRolled()]
Roll 3d6 minimum 2: [e: 3D6L2]
Get New Rolls: [r: getNewRolls()]
Get Rolled: [r: getRolled()]
-- Clear Rolls --[h: clearRolls()]
Roll 3d6: [e: 3D6]
Get New Rolls: [r: getNewRolls()]
Get Rolled: [r: getRolled()]
</syntaxhighlight>

Output: <source lang="mtmacro" line>

Roll 3d6: « 3D6 = 12 » Get New Rolls: [5,5,2] Get Rolled: [5,5,2] Roll 3d6 minimum 2: « 3D6L2 = 17 » Get New Rolls: [5,6,6] Get Rolled: [5,5,2,5,6,6] -- Clear Rolls -- Roll 3d6: « 3D6 = 8 » Get New Rolls: [2,2,4] Get Rolled: [2,2,4]

</syntaxhighlight>

See Also