setInitiativeHold: Difference between revisions

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.

• 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.

setInitiativeHold(value)
setInitiativeHold(value, id)
setInitiativeHold(value, id, mapRef)

Parameters

value - The initiative hold value to set.
id - The token id of 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.

@@ Line 1: / Line 1: @@
-==Function setInitiativeHold==
+{{stub}}
-Sets if the [[Token:Current Token|Current Token]] is [[Initiative:on hold|on hold]] in the [[Initiative:Initiative Panel|Initiative Panel]]. If the value passed is non zero then the [[Token:Current Token|Current Token]] is placed [[Initiative:on hold|on hold]], if it is 0 it is removed from [[Initiative:on hold|on hold]].
+{{MacroFunction
+|name=setInitiativeHold
+|version=1.3b41
+|description=
+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=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: setInitiativeHold(value)]
+setInitiativeHold(value)
-</source>
+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]]