setInitiative: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b41 | |version=1.3b41 | ||
|description= | |description= | ||
Sets the [[ | Sets the [[Introduction to Initiative|Initiative]] of the [[Current Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setInitiative( | setInitiative(value) | ||
</ | setInitiative(value, id) | ||
setInitiative(value, id, mapRef) | |||
</syntaxhighlight> | |||
{{param|value|The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.}} | |||
{{param|id|The token {{code|id}} of the token to have its initiative set. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setInitiative(1d20)] | [h: setInitiative(1d20)] | ||
</ | </syntaxhighlight> | ||
|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, 24 April 2023
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, mapRef)value- The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.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.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Examples
[h: setInitiative(1d20)]Version Changes
- 1.5.7 - Added
idandmapnameparameter options.