setCurrentInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 3: Line 3:
|trsuted=true
|trsuted=true
|description=
|description=
Gives the [[Initiative:Initiative|Initiative]] to the [[Token]] at the specified offset in the [[Iniatiative:Initiative Panel|Initiative Panel]]. Offsets start at 0.   
Gives the [[Introduction to Initiative|Initiative]] to the [[Token]] at the specified offset in the [[MapTool User Interface#Initiative|Initiative Panel]]. Offsets start at 0.   


To clear, specify a number that is not a valid token offset, like -1.
To clear, specify a number that is not a valid token offset, like -1.

Latest revision as of 21:07, 14 March 2023

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)]
[h: setCurrentInitiative(999)]