getMacroIndexes: Difference between revisions

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 token id or 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 id parameter option.
1.5.11 - Added mapname parameter option.
1.15 - Addition of "gm" and "campaign" options for id

@@ Line 1: / Line 1: @@
+{{stub|Examples of usage.}}
 {{MacroFunction
 |name=getMacroIndexes
 |version=1.3b48
-|description=Returns a list of the [[macro buttons]] on the [[Token:Current Token{{!}}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.
-* If the delimiter is not specified then a [[Macros:string list{{!}}string list]] is returned with the default value of ',' is used.
-* If the delimiter ''"json"'' then a [[Macros:json array{{!}}json array]] is returned.
-* Otherwise a [[Macros:string list{{!}}string list]] is returned with the delimiter passed in.
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight  lang="mtmacro" line>
 getMacroIndexes(label)
-</source>
-<source lang="mtmacro" line>
 getMacroIndexes(label, delim)
-</source>
+getMacroIndexes(label, delim, tokenRef)
-delim is the delimiter used to separate values in the [[Macros:string list{{!}}string list]] and defaults to "," if not specified.
+getMacroIndexes(label, delim, tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{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|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|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=
-* '''1.3b49''' - Added ''"json"'' delimiter option.
+{{change|1.3b49|Added {{code|"json"}} delimiter option.}}
+{{change|1.3b51|Added {{code|id}} 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]]

getMacroIndexes: Difference between revisions

Latest revision as of 23:59, 11 May 2024

getMacroIndexes() Function

Usage

Version Changes

Navigation menu