setInitiative: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setInitiative( | setInitiative(value) | ||
setInitiative(value, id) | |||
setInitiative(value, id, mapname) | |||
</source> | </source> | ||
{{param|value|The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list and duplicates are not allowed.}} | |||
{{param|id|The token {{code|id}} of the token to have its initiative set. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
| Line 15: | Line 21: | ||
[h: setInitiative(1d20)] | [h: setInitiative(1d20)] | ||
</source> | </source> | ||
|changes= | |||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
Revision as of 17:19, 10 October 2019
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setInitiative() Function
• Introduced in version 1.3b41
Sets the Initiative of the Current Token.
Usage
setInitiative(value)
setInitiative(value, id)
setInitiative(value, id, mapname)value- The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list and duplicates are not allowed.id- The tokenidof the token to have its initiative set. 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.
Examples
[h: setInitiative(1d20)]Version Changes
- 1.5.7 - Added
idandmapnameparameter options.