removeMacro: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
removeMacro(index)
removeMacro(index)
removeMacro(index, id)
removeMacro(index, id)
removeMacro(index, id, mapname)
removeMacro(index, id, mapname)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|index|The index of the macro button.}}
{{param|index|The index of the macro button.}}
{{param|id|The token {{code|id}} of the token the macro is located on.}}
{{param|id|The token {{code|id}} of the token the macro is located on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|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 05:16, 17 March 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, id)
removeMacro(index, id, mapname)

Parameters

  • index - The index of the macro button.
  • id - The token id of the token the macro is located on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.
  • mapname - The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.5.11 - Added mapname parameter option.
  • 1.15 - Addition of "gm" and "campaign" options for id