removeFromInitiative: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
removeFromInitiative() | removeFromInitiative() | ||
removeFromInitiative(id) | removeFromInitiative(id) | ||
removeFromInitiative(id, mapname) | removeFromInitiative(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 19: | Line 19: | ||
To remove the token with the name "Dragon" in current map from the [[introduction to Initiative|initiative panel]]. | To remove the token with the name "Dragon" in current map from the [[introduction to Initiative|initiative panel]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: removeFromInitiative("Dragon")] | [h: removeFromInitiative("Dragon")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 22:13, 14 March 2023
removeFromInitiative() Function
Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.
Usage
removeFromInitiative()
removeFromInitiative(id)
removeFromInitiative(id, mapname)Parameters
id- The tokenidof the token to be removed from the initiative. 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.return- Returns 1 if removed from the initiative, 0 if did not.
Example
To remove the token with the name "Dragon" in current map from the initiative panel.
[h: removeFromInitiative("Dragon")]See Also
addToInitiative() removeAllFromInitiative() removeAllNPCsFromInitiative() removeAllPCsFromInitiative()
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.