getInitiativeHold: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version, cleaned up formatting.)
(Add id and mapname parameters.)
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getInitiativeHold()
getInitiativeHold()
getInitiativeHold(id)
getInitiativeHold(id, mapname)
</source>
</source>
'''Parameter'''
{{param|id|The token {{code|id}} of the token to get the initiative hold value from. Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token if the id parameter is used. Defaults to the current map.}}


|examples=
|examples=

Revision as of 16:06, 10 April 2020

 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()
getInitiativeHold(id)
getInitiativeHold(id, mapname)

Parameter

  • id - The token id of 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

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