getMacros: Difference between revisions

Revision as of 23:49, 14 January 2020

• 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.

getMacros()
getMacros(delim)
getMacros(delim, id)
getMacros(delim, id, maptool)

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 ","
id - The token id 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.

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

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

@@ Line 8: / Line 8: @@
 <source lang="mtmacro" line>
 getMacros()
-</source>
-<source lang="mtmacro" line>
 getMacros(delim)
-</source>
-<source lang="mtmacro" line>
 getMacros(delim, id)
+getMacros(delim, id, maptool)
 </source>
 '''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|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.}}
 |examples=
@@ Line 29: / Line 27: @@
 {{change|1.3b49|Added {{code|json}} delimiter option.}}
 {{change|1.3b51|Added optional token {{code|id}} parameter.}}
+{{change|1.5.11|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Metamacro Function]]