getInitiative: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getInitative== Returns the Iniatiative:initiative of the current Token:token ===Usage=== <source lang="mtmacro" line> [h: init = getInitiative()] </source> ===Examp...) |
No edit summary |
||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
= | {{stub}} | ||
{{MacroFunction | |||
|name=getInitative | |||
|version=1.3b41 | |||
|description=Returns the [[Introduction to Initiative|initiative]] of the current [[Token:token{{!}}token]] | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getInitiative() | |||
getInitiative(id) | |||
getInitiative(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token to get the initiative value from. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
[ | {{param|mapname|The name of the map to find the token if the id parameter is used. Defaults to the current map.}} | ||
|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]] |
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 tokenid
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())]