getMacroIndexes: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetMacroIndexes to getMacroIndexes: Converting page titles to lowercase) |
No edit summary |
||
Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getMacroIndexes(label) | getMacroIndexes(label) | ||
getMacroIndexes(label, delim) | getMacroIndexes(label, delim) | ||
getMacroIndexes(label, delim, id) | getMacroIndexes(label, delim, id) | ||
getMacroIndexes(label, delim, id, mapname) | getMacroIndexes(label, delim, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|label|The label for the macro buttons to return.}} | {{param|label|The label for the macro buttons to return.}} |
Revision as of 18:39, 14 March 2023
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.
getMacroIndexes() Function
• Introduced in version 1.3b48
Returns a list of the macro buttons on the Current Token that have the specified label. The type of the value returned depends on the delimiter parameter.
Usage
getMacroIndexes(label)
getMacroIndexes(label, delim)
getMacroIndexes(label, delim, id)
getMacroIndexes(label, delim, id, mapname)
Parameters
label
- The label for the macro buttons to return.delim
- The delimiter used to separate the values in the String List which defaults to","
if not specified. This function returns a JSON Object if"json"
is specified.id
- The tokenid
of 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.
Version Changes
- 1.3b49 - Added
"json"
delimiter option. - 1.3b51 - Added
id
parameter option. - 1.5.11 - Added
mapname
parameter option.