getSpeechNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns a list containing the [[Introduction to Tokens:Speech|speech]] names of the [[Current Token]]. The type of the value returned depends on the delimiter parameter.  
Returns a list containing the [[Introduction to Tokens#Speech|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 [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used.
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used.
* If the delimiter {{code|json}} then a [[JSON Array]] is returned.
* If the delimiter {{code|json}} then a [[JSON Array]] is returned.

Revision as of 18:39, 20 April 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.