getInitiativeHold: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
No edit summary |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|name=getInitiativeHold | |name=getInitiativeHold | ||
|version=1.3b41 | |version=1.3b41 | ||
|description=Returns if the [[Token | |description=Returns if the [[Token|token]] is on [[Introduction to Initiative#Hold|hold]] in the [[Introduction to Initiative{{!}}initiative panel]] or not. This function will return 1 if the [[Token:token{{!}}token]] is on [[Introduction to Initiative#Hold|hold]] or 0 if it is not. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getInitiativeHold() | getInitiativeHold() | ||
</ | getInitiativeHold(tokenRef) | ||
getInitiativeHold(tokenRef, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to get the initiative hold 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.}} | |||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")] | [r: if(getInitiativeHold(), "You are on hold", "You are not on hold")] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
Latest revision as of 03:03, 13 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getInitiativeHold() Function
• Introduced in version 1.3b41
Returns if the token is on hold in the initiative panel or not. This function will return 1 if the token is on hold or 0 if it is not.
Usage
getInitiativeHold()
getInitiativeHold(tokenRef)
getInitiativeHold(tokenRef, mapname)Parameter
tokenRef- Either the tokenidor Token Name of the token to get the initiative hold 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.
Examples
[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")]