getCurrentInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getCurrentInitiative== {{GMOnlyFunction}} Gets the offset of the Token:token in the Initiative:initiative panel that has the Initiative:initiative. The offset sta...)
 
No edit summary
Line 1: Line 1:
==Function getCurrentInitiative==
{{MacroFunction
{{GMOnlyFunction}}
|name=getCurrentInitiative
Gets the offset of the [[Token:token|token]] in the [[Initiative:initiative panel|initiative panel]] that has the [[Initiative:initiative|initiative]]. The offset starts at 0, if no token has [[Initiative:initiative|initiative]] then -1 is returned.
|trusted=true
|description=Gets the offset of the [[Token:token|token]] in the [[Initiative:initiative panel|initiative panel]] that has the [[Initiative:initiative|initiative]]. The offset starts at 0, if no token has [[Initiative:initiative|initiative]] then -1 is returned.


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: offset = getCurrentInitiative()]
[h: offset = getCurrentInitiative()]
</source>
</source>
}}
[[Category:Initiative Function]]

Revision as of 02:50, 7 March 2009

getCurrentInitiative() Function

 Note: This function can only be used in a Trusted Macro

Gets the offset of the token in the initiative panel that has the initiative. The offset starts at 0, if no token has initiative then -1 is returned.

Usage

[h: offset = getCurrentInitiative()]