getMacroIndexes: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
No edit summary |
||
| Line 8: | Line 8: | ||
<source lang="mtmacro" line> | <source 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) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 19: | Line 16: | ||
{{param|delim|The delimiter used to separate the values in the [[String List]] which defaults to {{code|","}} if not specified. This function returns a [[JSON Object]] if {{code|"json"}} is specified.}} | {{param|delim|The delimiter used to separate the values in the [[String List]] which defaults to {{code|","}} if not specified. This function returns a [[JSON Object]] if {{code|"json"}} is specified.}} | ||
{{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.}} | |||
|changes= | |changes= | ||
{{change|1.3b49|Added {{code|"json"}} delimiter option.}} | {{change|1.3b49|Added {{code|"json"}} delimiter option.}} | ||
{{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:47, 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.
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 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.
Version Changes
- 1.3b49 - Added
"json"delimiter option. - 1.3b51 - Added
idparameter option. - 1.5.11 - Added
mapnameparameter option.