setInitiativeHold: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b41 | |version=1.3b41 | ||
|description= | |description= | ||
Sets if the [[Current Token]] is [[Initiative | Sets if the [[Current Token]] is [[Introduction to Initiative#Hold|on hold]] in the [[Initiative:Initiative Panel|Initiative Panel]]. If the value passed is non zero then the [[Current Token]] is placed [[Introduction to Initiative#Hold|on hold]], if it is 0 it is removed from [[Introduction to Initiative#Hold|on hold]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setInitiativeHold(value) | setInitiativeHold(value) | ||
</ | setInitiativeHold(value, id) | ||
setInitiativeHold(value, id, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|value|The initiative hold value to set.}} | |||
{{param|id|The token {{code|id}} of the token to set the initiative hold. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID 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]] | ||
Latest revision as of 23:59, 14 March 2023
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, mapRef)Parameters
value- The initiative hold value to set.id- The tokenidof the token to set the initiative hold. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.