getMacros

From RPTools Wiki
Revision as of 18:35, 7 March 2009 by Merkuri (talk | contribs) (Macros:Functions:getMacros moved to getMacros: Moving out of Macros namespace.)
Jump to navigation Jump to search

Function getMacros

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.

  • If the delimiter is not specified then a string list is returned with the default value of ',' is used.
  • If the delimiter "json" then a json array is returned. (as of MapTool 1.3b49)
  • Otherwise a string list is returned with the delimiter passed in.

Usage

[h: macros = getMacros()]
[h: macros = getMacros(delim)]

delim is the delimiter used to separate the values in the string list which defaults to ',' if not specified.


Examples

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

[h: macroLables = getMacros()]
[foreach(macro, macroLables, "<br>"): macro]
Retrieved from "https://rptools.hyperbooks.com/index.php?title=getMacros&oldid=1276"