getInitiativeHold

 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(tokenRef)
getInitiativeHold(tokenRef, mapRef)

Parameter

• tokenRef - Either the token id or Token Name 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. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Examples

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