getInitiative: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|name=getInitative | |name=getInitative | ||
|version=1.3b41 | |version=1.3b41 | ||
|description=Returns the [[ | |description=Returns the [[Introduction to Initiative|initiative]] of the current [[Token:token{{!}}token]] | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getInitiative() | getInitiative() | ||
getInitiative(id) | getInitiative(id) | ||
getInitiative(id, mapname) | getInitiative(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
| Line 17: | Line 17: | ||
|example= | |example= | ||
< | <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())] | ||
</syntaxhighlight> | |||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
Latest revision as of 23:31, 24 April 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 tokenidof 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())]