getInitiativeHold

From RPTools Wiki
Revision as of 16:06, 10 April 2020 by Melek (talk | contribs) (Add id and mapname parameters.)
Jump to navigation Jump to search

 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")]
Retrieved from "https://wiki.rptools.info/index.php?title=getInitiativeHold&oldid=8572"