getMacros: Difference between revisions

Latest revision as of 23:59, 13 May 2024

getMacros() Function

• Introduced in version 1.3b48

Returns a list of the labels of all of the macro buttons on the Current Token. The type of the value returned depends on the delimiter parameter.

Usage

getMacros()
getMacros(delim)
getMacros(delim, tokenRef)
getMacros(delim, tokenRef, mapRef)

Parameters

delim - The delimiter used to separate the values in the String List, a JSON array is returned if "json" is specified as the delimiter. Defaults to ","
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.

Examples

To display all of the macro button labels on the current token use.

[h: macroLabels = getMacros()]
[foreach(macro, macroLabels, "<br>"): macro]

Version Changes

1.3b49 - Added json delimiter option.
1.3b51 - Added optional token id parameter.
1.5.11 - Added mapname parameter option.
1.15 - Addition of "gm" and "campaign" options for id

@@ Line 1: / Line 1: @@
-==Function getMacros==
+{{MacroFunction
+|name=getMacros
+|version=1.3b48
+|description=
+Returns a list of the labels of all of the [[Macro_Button|macro buttons]] on the [[Current Token]]. The type of the value returned depends on the delimiter parameter.
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getMacros()
+getMacros(delim)
+getMacros(delim, tokenRef)
+getMacros(delim, tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{param|delim|The delimiter used to separate the values in the  [[String List]], a JSON array is returned if {{code|"json"}} is specified as the delimiter. Defaults to {{code|","}} }}
+{{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.}}
-Returns a list of the labels of all of the [[macro buttons]] on the [[Token:Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter.
+|examples=
-* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
+To display all of the [[Macro_Button|macro button]] labels on the current [[Token|token]] use.
-* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+<syntaxhighlight lang="mtmacro" line>
-* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+[h: macroLabels = getMacros()]
+[foreach(macro, macroLabels, "<br>"): macro]
+</syntaxhighlight>
-===Usage===
+|changes=
-<source lang="mtmacro" line>
+{{change|1.3b49|Added {{code|json}} delimiter option.}}
-[h: macros = getMacros()]
+{{change|1.3b51|Added optional token {{code|id}} parameter.}}
-[h: macros = getMacros(delim)]
+{{change|1.5.11|Added {{code|mapname}} parameter option.}}
-</source>
+{{change|1.15|Addition of "gm" and "campaign" options for id}}
-delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' if not specified.
+}}
+[[Category:Metamacro Function]]
-===Examples===
-To display all of the [[macro button]] labels on the current [[Token:token|token]] use.
-<source lang="mtmacro" line>
-[h: macroLables = getMacros()]
-[foreach(macro, macroLables, "<br>"): macro]
-</source>