removeMacro

 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 token id or 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 mapname parameter option.
• 1.15 - Addition of "gm" and "campaign" options for id