getMacroCommand: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=getMacroCommand
|name=getMacroCommand
Line 8: Line 9:
getMacroCommand(index)
getMacroCommand(index)
</source>
</source>
<source lang="mtmacro" line>
getMacroCommand(index, id)
</source>
'''Parameters'''
{{param|index|The index of the macro button which will have the command returned.}}
{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}
|also=
[[getMacroIndexes|getMacroIndexes()]]
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Metamacro Function]]
[[Category:Metamacro Function]]

Revision as of 23:19, 30 March 2009

 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.