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==
==Function getMacroIndexes==


Returns a [[Macros:string list|string list]] of the [[macro buttons]] on the [[Token:Current Token|Current Token]] that have the specified label.
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. '''(as of MapTool 1.3b49)'''
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.


===Usage===
===Usage===

Revision as of 14:21, 24 December 2008

Function getMacroIndexes

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. (as of MapTool 1.3b49)
  • 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.