count (roll option): Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Initial copy-over.)
m (Text replacement - "<source" to "<syntaxhighlight")
 
(6 intermediate revisions by 5 users not shown)
Line 7: Line 7:


====Usage====
====Usage====
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[COUNT(num): body]
[COUNT(num): body]
[COUNT(num, separator): body]
[COUNT(num, separator): body]
</source>
</syntaxhighlight>


The ''[[roll.count]]'' variable will take on values from 0 to (number of loops - 1). The optional separator (default ", ") is printed between each iteration.
The ''[[roll.count]]'' variable will take on values from {{code|0}} to ({{code|number of loops - 1}}). The optional separator (default {{code|","}}) is printed between each iteration. Some examples of other useful separators: ''nothing'' {{code|""}}, ''space'' {{code|" "}} and ''break'' {{code|"&lt;br>"}}.


====Example====
====Example====
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:numHits=3]
[h:numHits=3]
[COUNT(numHits): Damage = Damage + 1d12]
[COUNT(numHits): Damage = Damage + 1d12]
</source>
</syntaxhighlight>


This will iterate the ''Damage = Damage + 1d12'' operation 3 times, separating the result of each iteration with the default separator (a comma). An optional second argument to COUNT() allows the setting of a different separator.
This will iterate the {{code|Damage {{=}} Damage + 1d12}} operation 3 times, separating the result of each iteration with the default separator (a comma). An optional second argument to {{code|COUNT()}} allows the setting of a different separator.


[[Category:Roll Option]]
[[Category:Roll Option]]
[[Category:Looping Roll Option]]
[[Category:Looping Roll Option]]

Latest revision as of 18:18, 14 March 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

COUNT Option

Introduced: Version 1.3.b41

The COUNT option executes a statement for a specified number of times, storing the number of the current iteration in a variable called roll.count.

Usage

[COUNT(num): body]
[COUNT(num, separator): body]

The roll.count variable will take on values from 0 to (number of loops - 1). The optional separator (default ",") is printed between each iteration. Some examples of other useful separators: nothing "", space " " and break "<br>".

Example

[h:numHits=3]
[COUNT(numHits): Damage = Damage + 1d12]

This will iterate the Damage = Damage + 1d12 operation 3 times, separating the result of each iteration with the default separator (a comma). An optional second argument to COUNT() allows the setting of a different separator.