getMacroCommand

 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.

getMacroCommand() Function

• Introduced in version 1.3b48

Returns the command that would be executed for a macro button on the Current Token. The getMacroIndexes() function can be used to get the index of a macro button.

Usage

getMacroCommand(index)
getMacroCommand(index, id)
getMacroCommand(index, id, mapname)

Parameters

• index - The index of the macro button which will have the command returned.
• id - The token id of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.

   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.

See Also

getMacroIndexes()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.11 - Added mapname parameter option.
• 1.5.11 - Added mapname parameter option.