getMacros: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) No edit summary |
Verisimilar (talk | contribs) mNo edit summary |
||
| Line 17: | Line 17: | ||
'''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 the function is executed on. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }} | ||
|examples= | |examples= | ||
Revision as of 01:10, 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 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
jsondelimiter option. - 1.3b51 - Added optional token
idparameter.