count (roll option): Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Redirect pending split of article.)
 
m (Initial copy-over.)
Line 1: Line 1:
#REDIRECT [[Macros:Branching and Looping]]
{{stub}}
===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 ''[[Macros:Special_Variables:roll.count|roll.count]]''.
 
====Usage====
<source lang="mtmacro" line>
[COUNT(num): body]
[COUNT(num, separator): body]
</source>
 
The ''[[roll.count]]'' variable will take on values from 0 to (number of loops - 1). The optional separator (default ", ") is printed between each iteration.
 
====Example====
<source lang="mtmacro" line>
[h:numHits=3]
[COUNT(numHits): Damage = Damage + 1d12]
</source>
 
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.
 
[[Category:Roll Option]]
[[Category:Roll Option]]
[[Category:Looping Roll Option]]
[[Category:Looping Roll Option]]

Revision as of 04:11, 5 April 2009

 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.

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.