getMacros: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
Returns a | 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. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | |||
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)''' | |||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | |||
===Usage=== | ===Usage=== | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
Revision as of 14:19, 24 December 2008
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]