getInitiativeHold: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 10: | Line 10: | ||
getInitiativeHold(id) | getInitiativeHold(id) | ||
getInitiativeHold(id, mapname) | getInitiativeHold(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
| Line 19: | Line 19: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")] | [r: if(getInitiativeHold(), "You are on hold", "You are not on hold")] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
Revision as of 17:59, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getInitiativeHold() Function
• Introduced in version 1.3b41
Returns if the token is on hold in the initiative panel or not. This function will return 1 if the token is on hold or 0 if it is not.
Usage
<source lang="mtmacro" line> getInitiativeHold() getInitiativeHold(id) getInitiativeHold(id, mapname) </syntaxhighlight>
Parameter
id- The tokenidof the token to get the initiative hold value from. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token if the id parameter is used. Defaults to the current map.
Examples
<source lang="mtmacro" line>
[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")]
</syntaxhighlight>