getMacroButtonIndex: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getMacroButtonIndex moved to getMacroButtonIndex) |
Verisimilar (talk | contribs) m (This function doesn't seem to work, and I can't find any documentation that says it ever actually made it into a build. Take off the proposed if I'm wrong about this.) |
||
Line 1: | Line 1: | ||
{{stub}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getMacroButtonIndex | |name=getMacroButtonIndex | ||
|proposed=true | |||
|version=1.3b50 | |version=1.3b50 | ||
|description=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. | |description=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. |
Revision as of 00:19, 11 March 2009
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:
-1Otherwise it returns a non negative number which is the index of the button.