setCurrentInitiative

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 initiative, any number that is not a valid token offset.

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