getInitiative

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getInitative() Function

• Introduced in version 1.3b41

Returns the initiative of the current token

Usage

getInitiative()
getInitiative(tokenRef)
getInitiative(tokenRef, mapRef)

Parameter

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

Example

Your initiative is [r: getInitiative()]
The initiative value of the token that currently has the initiative is [r: getInitiative(getInitiativeToken())]