setCurrentInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
[h: setCurrentInitiative(3)]
[h: setCurrentInitiative(3)]
</source>
</source>
Clear initiative.  (any number that is not a valid token offset will work)
Clear current initiative.  (any number that is not a valid token offset will work)
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setCurrentInitiative(-1)]    // Any negative number will do
[h: setCurrentInitiative(-1)]    // Any negative number will suffice.
[h: setCurrentInitiative(999)]  // Any number equal to or greater than the number of tokens in list.
[h: setCurrentInitiative(999)]  // Any number equal to or greater than the number of tokens in list.
</source>
</source>

Revision as of 06:29, 31 December 2010

setCurrentInitiative() Function

Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0. Specifying a number of -1 or a number equalto or greater than the number of tokens in initiative list will clear current initiative.

Usage

[h: setCurrentInitiative(offset)]

Examples

Give Initiative to the 4th Token.
[h: setCurrentInitiative(3)]

Clear current initiative. (any number that is not a valid token offset will work)

[h: setCurrentInitiative(-1)]    // Any negative number will suffice.
[h: setCurrentInitiative(999)]   // Any number equal to or greater than the number of tokens in list.