getMacroIndexes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==Function getMacroIndexes==
{{MacroFunction
|name=getMacroIndexes
|description=Returns a list of the [[macro buttons]] on the [[Token:Current Token{{!}}Current Token]] that have the specified label. 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.
* Otherwise a [[Macros:string list{{!}}string list]] is returned with the delimiter passed in.


Returns a list of the [[macro buttons]] on the [[Token:Current Token|Current Token]] that have the specified label. The type of the value returned depends on the delimiter parameter.
|usage=
* 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===
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: indexes = getMacroIndexes(label)]
[h: indexes = getMacroIndexes(label)]
[h: indexes = getMacroIndexes(label, delim)]
[h: indexes = getMacroIndexes(label, delim)]
</source>
</source>
delim is the delimiter used to separate values in the [[Macros:string list|string list]] and defaults to "," if not specified.
delim is the delimiter used to separate values in the [[Macros:string list{{!}}string list]] and defaults to "," if not specified.
|changes=
* '''1.3b49''' - Added ''"json"'' delimiter option.
}}
[[Category:Metamacro Function]]

Revision as of 04:07, 7 March 2009

getMacroIndexes() Function

Returns a list of the macro buttons on the Current Token that have the specified label. 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.
  • Otherwise a string list is returned with the delimiter passed in.

Usage

[h: indexes = getMacroIndexes(label)]
[h: indexes = getMacroIndexes(label, delim)]

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


Version Changes

  • 1.3b49 - Added "json" delimiter option.