getMacroButtonIndex

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Expanded examples of usage.

getMacroButtonIndex() Function

• Introduced in version 1.3b50

Returns the index of the Token macro button that was clicked on. The macro button must have the auto-execute check box selected. If the macro is not running from a Token macro button then -1 is returned.

Usage

getMacroButtonIndex()

Example

[h: ind = getMacroButtonIndex()]

If the macro is not run from an auto-execute macro button on a Token, ind is set to -1. Otherwise ind is set to a non-negative number which is the index of the button.

See Also

getMacroIndexes()