getMacros: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
Verisimilar (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
|description= | |description= | ||
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. | 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. | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getMacros() | getMacros() | ||
</source> | |||
<source lang="mtmacro" line> | |||
getMacros(delim) | getMacros(delim) | ||
</source> | </source> | ||
delim | <source lang="mtmacro" line> | ||
getMacros(delim, id) | |||
</source> | |||
'''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|id|The token {{code|id}} of the token the function is executed on. {{TrustedParameter}} }} | |||
|examples= | |examples= | ||
| Line 24: | Line 28: | ||
|changes= | |changes= | ||
{{change|1.3b49|Added {{code|json}} delimiter option.}} | {{change|1.3b49|Added {{code|json}} delimiter option.}} | ||
{{change|1.3b51|Added optional token {{code|id}} parameter.}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] | ||
Revision as of 01:09, 23 March 2009
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 tokenidof the token 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
jsondelimiter option. - 1.3b51 - Added optional token
idparameter.