getInitiativeHold: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version, cleaned up formatting.)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=getInitiativeHold
|name=getInitiativeHold
|version=1.3b41
|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.
|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.


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: onHold = getInitiativeHold()]
getInitiativeHold()
</source>
</source>


Line 14: Line 16:
}}
}}
[[Category:Initiative Function]]
[[Category:Initiative Function]]
[[Category:Token Function]]

Revision as of 10:06, 10 March 2009

 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

getInitiativeHold()

Examples

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