getInitiative: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) No edit summary |
No edit summary |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getInitative | |name=getInitative | ||
|description=Returns the [[ | |version=1.3b41 | ||
|description=Returns the [[Introduction to Initiative|initiative]] of the current [[Token:token{{!}}token]] | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getInitiative() | |||
</ | getInitiative(tokenRef) | ||
getInitiative(tokenRef, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|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 03:02, 13 May 2024
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(tokenRef)
getInitiative(tokenRef, mapname)Parameter
tokenRef- Either the tokenidor Token Name 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Example
Your initiative is [r: getInitiative()]
The initiative value of the token that currently has the initiative is [r: getInitiative(getInitiativeToken())]