getInitiativeHold: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getInitiativeHold== Returns if the Token:token is on Initiative:hold in the Initiative:initiative panel or not. This function will return 1 if the [[Token:token|...)
 
No edit summary
Line 1: Line 1:
==Function getInitiativeHold==
{{MacroFunction
|name=getInitiativeHold
|description=Returns if the [[Token:token{{!}}token]] is on [[Initiative:hold{{!}}hold]] in the [[Initiative:initiative panel{{!}}initiative panel]] or not. This function will return 1 if the [[Token:token{{!}}token]] is on [[Initiative:hold{{!}}hold]] or 0 if it is not.


Returns if the [[Token:token|token]] is on [[Initiative:hold|hold]] in the [[Initiative:initiative panel|initiative panel]] or not. This function will return 1 if the [[Token:token|token]] is on [[Initiative:hold|hold]] or 0 if it is not.
|usage=
 
===Usage===
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: onHold = getInitiativeHold()]
[h: onHold = getInitiativeHold()]
</source>
</source>


===Examples===
|examples=
<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")]
</source>
</source>
}}
[[Category:Initiative Function]]
[[Category:Token Function]]

Revision as of 03:39, 7 March 2009

getInitiativeHold() Function

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

[h: onHold = getInitiativeHold()]

Examples

[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")]