setCurrentInitiative

setCurrentInitiative() Function

Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0. To clear, specify a number that is not a valid token offset like -1.

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.