getInitiativeHold: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getInitiativeHold== Returns if the Token:token is on Initiative:hold in the Initiative:initiative panel or not. This function will return 1 if the [[Token:token|...) |
No edit summary |
||
(12 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
= | {{stub}} | ||
{{MacroFunction | |||
|name=getInitiativeHold | |||
|version=1.3b41 | |||
|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= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getInitiativeHold() | |||
getInitiativeHold(id) | |||
getInitiativeHold(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} 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.}} | ||
|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]] |
Latest revision as of 23:09, 4 May 2023
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(id)
getInitiativeHold(id, mapname)
Parameter
id
- The tokenid
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.
Examples
[r: if(getInitiativeHold(), "You are on hold", "You are not on hold")]