setInitiativeHold: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| Line 9: | Line 9: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setInitiativeHold(value) | setInitiativeHold(value) | ||
setInitiativeHold(value, id) | |||
setInitiativeHold(value, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|value|The initiative hold value to set.}} | |||
{{param|id|The token {{code|id}} of the token to set the initiative hole. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|changes= | |||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
Revision as of 17:22, 10 October 2019
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setInitiativeHold() Function
• Introduced in version 1.3b41
Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.
Usage
setInitiativeHold(value)
setInitiativeHold(value, id)
setInitiativeHold(value, id, mapname)Parameters
value- The initiative hold value to set.id- The tokenidof the token to set the initiative hole. 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. Defaults to the current map.
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.