getMacros: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
m (Fixing wikilinks) |
||
Line 3: | Line 3: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
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. | Returns a list of the labels of all of the [[Macro_Button|macro buttons]] on the [[Current Token]]. The type of the value returned depends on the delimiter parameter. | ||
|usage= | |usage= | ||
Line 20: | Line 20: | ||
|examples= | |examples= | ||
To display all of the [[macro button]] labels on the current [[Token | To display all of the [[Macro_Button|macro button]] labels on the current [[Token|token]] use. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: macroLables = getMacros()] | [h: macroLables = getMacros()] |
Revision as of 15:21, 19 July 2011
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)
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.
Examples
To display all of the macro button labels on the current token use.
[h: macroLables = getMacros()]
[foreach(macro, macroLables, "<br>"): macro]
Version Changes
- 1.3b49 - Added
json
delimiter option. - 1.3b51 - Added optional token
id
parameter.