getSpeechNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 10: Line 10:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getSpeechNames()
getSpeechNames()
getSpeechNames(delim)
getSpeechNames(delim)
Line 18: Line 18:
|example=
|example=
To display the names of all of the [[Token:speech|speech]] values for the [[Current Token]] use.
To display the names of all of the [[Token:speech|speech]] values for the [[Current Token]] use.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: names = getSpeech()]
[h: names = getSpeech()]
[foreach(name, names, "<br>"): name]
[foreach(name, names, "<br>"): name]

Revision as of 20:42, 14 March 2023

getSpeechNames() Function

Introduced in version 1.3b48
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.
  • Otherwise a string list is returned with the delimiter passed in.
 

Usage

getSpeechNames()
getSpeechNames(delim)

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

Example

To display the names of all of the speech values for the Current Token use.
[h: names = getSpeech()]
[foreach(name, names, "<br>"): name]


Version Changes

  • 1.3b49 - Added json delimiter option.