getMacros: Difference between revisions
Jump to navigation
Jump to search
(No difference)
|
Revision as of 22:54, 9 February 2023
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, id)
getMacros(delim, id, mapname)
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 tokenid
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.
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.