setInitiative: Difference between revisions

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.

• Introduced in version 1.3b41

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 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.
mapRef - The Name or ID of the map to find the token. Defaults to the current map.

[h: setInitiative(1d20)]

@@ Line 1: / Line 1: @@
-==Function setInitiative==
+{{stub}}
-Sets the [[Initiative:Initiative|Initiative]] of the [[Token:Current Token|Current Token]].
+{{MacroFunction
+|name=setInitiative
+|version=1.3b41
+|description=
+Sets the [[Introduction to Initiative|Initiative]] of the [[Current Token]].
-===Usage===
+|usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: setInitiative(val)]
+setInitiative(value)
-</source>
+setInitiative(value, id)
+setInitiative(value, id, mapRef)
+</syntaxhighlight>
-===Examples===
+{{param|value|The initiative value to set.  If included, the initiative will be set even if the token is already on the initiative list.}}
-<source lang="mtmacro" line>
+{{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=
+<syntaxhighlight lang="mtmacro" line>
 [h: setInitiative(1d20)]
-</source>
+</syntaxhighlight>
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
+}}
+[[Category:Initiative Function]]