getInitiative

From RPTools Wiki
Revision as of 22:16, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page getInitiative to GetInitiative without leaving a redirect: Converting page title to first-letter uppercase)
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.

getInitative() Function

• Introduced in version 1.3b41
Returns the initiative of the current token

Usage

getInitiative()
getInitiative(id)
getInitiative(id, mapname)

Parameter

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

  • mapname - The name of the map to find the token if the id parameter is used. Defaults to the current map.

Example

Your initiative is [r: getInitiative()]
The initiative value of the token that currently has the initiative is [r: getInitiative(getInitiativeToken())]
Retrieved from "https://rptools.hyperbooks.com/index.php?title=getInitiative&oldid=11993"