setInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page setInitiative to SetInitiative without leaving a redirect: Converting page title to first-letter uppercase)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
|version=1.3b41
|version=1.3b41
|description=
|description=
Sets the [[Initiative:Initiative|Initiative]] of the [[Current Token]].
Sets the [[Introduction to Initiative|Initiative]] of the [[Current Token]].


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setInitiative(value)
setInitiative(value)
setInitiative(value, id)
setInitiative(value, id)
setInitiative(value, id, mapname)
setInitiative(value, id, mapname)
</source>
</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|value|The initiative value to set.  If included, the initiative will be set even if the token is already on the initiative list.}}
Line 18: Line 18:


|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setInitiative(1d20)]
[h: setInitiative(1d20)]
</source>
</syntaxhighlight>


|changes=
|changes=

Latest revision as of 23:31, 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, mapname)
  • 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 token id of 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 id and mapname parameter options.