getMacroCommand: Difference between revisions
Jump to navigation
Jump to search
m (Fixing wikilinks) |
No edit summary |
||
| Line 8: | Line 8: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getMacroCommand(index) | getMacroCommand(index) | ||
getMacroCommand(index, id) | getMacroCommand(index, id) | ||
getMacroCommand(index, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|index|The index of the macro button which will have the command returned.}} | {{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}} }} | {{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|also= | |also= | ||
| Line 21: | Line 21: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.11|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] | ||
Revision as of 23:37, 14 January 2020
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)
getMacroCommand(index, id, mapname)Parameters
index- The index of the macro button which will have the command returned.id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.11 - Added
mapnameparameter option.