for (roll option)
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
[for():] Roll Option
Executes a statement for a number of iterations based on a start and end value.
Usage
[for(var, start, end): body]
[for(var, start, end, stepsize): body]
[for(var, start, end, stepsize, separator): body]
Parameters
The var
variable counts from start
towards end
during the loop, and the optional stepsize
(default +1
) is added to var
at each iteration. Note that in the standard incrementing usage with a stepsize
of 1
, the body
does not execute when var
reaches end
.
Note that stepsize
must be integer and not 0. Floating values will be rounded down.
list_separator
default value is ","
Some examples of other useful delimiters: nothing ""
, space " "
and break "<br>"
Examples
[for(i,0,10): "i is now " + i]
Counts up from 0 to 9.
[for(i,10,0,-2): "i is now " + i]
Counts down even numbers from 10 to 0.
See Also
[foreach():], Introduction to Macro Loops
Version Changes
- 1.3b54 - Changed the comparison operator when comparing the
var
toend
when determining whether to continue executing a new iteration. In version 1.3b53 and earlier, on each iteration it compared ifvar
was less than or equal toend
. As of version 1.3b54, it is now comparing ifvar
is less thanend
.