getMacroCommand: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getMacroCommand to GetMacroCommand without leaving a redirect: Converting page title to first-letter uppercase) |
Bubblobill (talk | contribs) mNo edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getMacroCommand(index) | getMacroCommand(index) | ||
getMacroCommand(index, id) | getMacroCommand(index, id) | ||
getMacroCommand(index, id, mapname) | getMacroCommand(index, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''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. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.{{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
| Line 22: | Line 22: | ||
{{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.}} | {{change|1.5.11|Added {{code|mapname}} parameter option.}} | ||
{{change|1.15|Addition of "gm" and "campaign" options for id}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] | ||
Latest revision as of 05:14, 17 March 2024
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. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.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. - 1.15 - Addition of "gm" and "campaign" options for id