removeMacro: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
removeMacro(index) | removeMacro(index) | ||
removeMacro(index, | removeMacro(index, tokenRef) | ||
removeMacro(index, | removeMacro(index, tokenRef, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|index|The index of the macro button.}} | {{param|index|The index of the macro button.}} | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token the macro is located on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.}} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
{{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.}} | |||
|changes= | |changes= | ||
{{change|1.5.11|Added {{code|mapname}} parameter option.}} | {{change|1.5.11|Added {{code|mapname}} parameter option.}} | ||
{{change|1.15|Addition of "gm" and "campaign" options for id}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] | ||
Latest revision as of 23:59, 17 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage.
removeMacro() Function
• Introduced in version 1.3b51
Removes a macro button from a token.
Usage
removeMacro(index)
removeMacro(index, tokenRef)
removeMacro(index, tokenRef, mapRef)Parameters
index- The index of the macro button.tokenRef- Either the tokenidor Token Name of the token the macro is located on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.mapRef- The Name or ID of the map to find the token. Defaults to the current map.
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.
Version Changes
- 1.5.11 - Added
mapnameparameter option. - 1.15 - Addition of "gm" and "campaign" options for id