removeFromInitiative: Difference between revisions

Latest revision as of 23:59, 17 May 2024

Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.

removeFromInitiative()
removeFromInitiative(tokenRef)
removeFromInitiative(tokenRef, mapRef)

Parameters

tokenRef - Either the token id or Token Name of the token to be removed from the initiative. 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.
return - Returns 1 if removed from the initiative, 0 if did not.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

To remove the token with the name "Dragon" in current map from the initiative panel.

[h: removeFromInitiative("Dragon")]

@@ Line 7: / Line 7: @@
 <syntaxhighlight lang="mtmacro" line>
 removeFromInitiative()
-removeFromInitiative(id)
+removeFromInitiative(tokenRef)
-removeFromInitiative(id, mapname)
+removeFromInitiative(tokenRef, mapRef)
 </syntaxhighlight>
 '''Parameters'''
-{{param|id|The token {{code|id}} of the token to be removed from the initiative.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to be removed from the initiative.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
-{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
+{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
 * {{code|return}} - Returns 1 if removed from the initiative, 0 if did not.
+{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
 |example=