getMacroCommand: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Unifying Current Token red link.)
m (Fixing wikilinks)
Line 3: Line 3:
|name=getMacroCommand
|name=getMacroCommand
|version=1.3b48
|version=1.3b48
|description=Returns the command that would be executed for a [[macro button]] on the [[Current Token]]. The [[getMacroIndexes{{!}} getMacroIndexes()]] function can be used to get the index of a [[macro button]].
|description=Returns the command that would be executed for a [[Macro_Button|macro button]] on the [[Current Token]]. The [[getMacroIndexes{{!}} getMacroIndexes()]] function can be used to get the index of a [[Macro_Button|macro button]].


|usage=
|usage=

Revision as of 15:12, 19 July 2011

 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)

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.

     Note: This parameter can only be used in a Trusted Macro


See Also

Version Changes

  • 1.3b51 - Added id parameter option.