getInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getInitiative()
getInitiative()
getInitiative(id)
getInitiative(id)
Line 17: Line 17:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Your initiative is [r: getInitiative()]
Your initiative is [r: getInitiative()]
The initiative value of the token that currently has the initiative is [r: getInitiative(getInitiativeToken())]
The initiative value of the token that currently has the initiative is [r: getInitiative(getInitiativeToken())]

Revision as of 18:13, 14 March 2023

 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())]