getSpeechNames

From RPTools Wiki
Revision as of 14:33, 24 December 2008 by Craig (talk | contribs)
Jump to navigation Jump to search

Function getSpeechNames

Returns a list containing the speech names of the Current Token. 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: macros = getSpeechNames()]
[h: macros = getSpeechNames(delim)]

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


Examples

To display the names of all of the speech values for the Current Token use.

[h: names = getSpeech()]
[foreach(name, names, "<br>"): name]