getMacros: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
Bubblobill (talk | contribs) mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 14: | Line 14: | ||
'''Parameters''' | '''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|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|id|The token {{code|id}} of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.{{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
| Line 28: | Line 28: | ||
{{change|1.3b51|Added optional token {{code|id}} parameter.}} | {{change|1.3b51|Added optional token {{code|id}} parameter.}} | ||
{{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 05:15, 17 March 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, 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 tokenidof 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.
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
jsondelimiter option. - 1.3b51 - Added optional token
idparameter. - 1.5.11 - Added
mapnameparameter option. - 1.15 - Addition of "gm" and "campaign" options for id