getInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetInitiative to getInitiative: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 10: Line 10:
getInitiative(id)
getInitiative(id)
getInitiative(id, mapname)
getInitiative(id, mapname)
</source>
</syntaxhighlight>


'''Parameter'''
'''Parameter'''
Line 20: Line 20:
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())]
</source>
</syntaxhighlight>
}}
}}
[[Category:Initiative Function]]
[[Category:Initiative Function]]

Revision as of 17:07, 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

<source lang="mtmacro" line> getInitiative() getInitiative(id) getInitiative(id, mapname) </syntaxhighlight>

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

<source lang="mtmacro" line>

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

</syntaxhighlight>