getMacroButtonIndex

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

Note: This refers to a proposed change that has not been implemented in the main code base yet.

getMacroButtonIndex() Function

• Introduced in version 1.3b50

Returns the index of the macro button that was clicked on for the token. 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

[h: ind = getMacroButtonIndex()]

Example

[h: ind = getMacroButtonIndex()]

If the macro is not run from an auto execute macro button on a token it returns:

-1

Otherwise it returns a non negative number which is the index of the button.

getMacroButtonIndex