getMacroIndexes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
|name=getMacroIndexes | |name=getMacroIndexes | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=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. | |description=Returns a list of the [[Macro Button|macro buttons]] on the [[Current Token]] that have the specified label. The type of the value returned depends on the delimiter parameter. | ||
|usage= | |usage= | ||
| Line 9: | Line 9: | ||
getMacroIndexes(label) | getMacroIndexes(label) | ||
getMacroIndexes(label, delim) | getMacroIndexes(label, delim) | ||
getMacroIndexes(label, delim, | getMacroIndexes(label, delim, tokenRef) | ||
getMacroIndexes(label, delim, | getMacroIndexes(label, delim, tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|label|The label for the macro buttons to return.}} | {{param|label|The label for the macro buttons to return.}} | ||
{{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| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.{{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|changes= | |changes= | ||
| Line 23: | Line 23: | ||
{{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 23:59, 11 May 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.
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, tokenRef)
getMacroIndexes(label, delim, tokenRef, mapRef)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.tokenRef- Either the tokenidor Token Name of 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.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Version Changes
- 1.3b49 - Added
"json"delimiter option. - 1.3b51 - Added
idparameter option. - 1.5.11 - Added
mapnameparameter option. - 1.15 - Addition of "gm" and "campaign" options for id