getSpeechNames: Difference between revisions

Latest revision as of 23:59, 13 May 2024

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)
getSpeechNames(delim, tokenRef)

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

tokenRefEither the token id or Token Name of the token to list speech names from.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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.

@@ Line 1: / Line 1: @@
-==Function getSpeechNames==
+{{MacroFunction
+|name=getSpeechNames
+|version=1.3b48
-Returns a list containing the [[Token:speech|speech]] names of the [[Token:Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter.
+|description=
-* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
+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 ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+* 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.
 * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+&nbsp;
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getSpeechNames()
+getSpeechNames(delim)
+getSpeechNames(delim, tokenRef)
+</syntaxhighlight>
+{{code|delim}} is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.
-===Usage===
+{{code|tokenRef}}Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to list speech names from.
-<source lang="mtmacro" line>
+{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
-[h: macros = getSpeechNames()]
-[h: macros = getSpeechNames(delim)]
-</source>
-delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' if not specified.
-===Examples===
+|example=
-To display the names of all of the [[Token:speech|speech]] values for the [[Token:Current Token|Current Token]] use.
+To display the names of all of the [[Introduction_to_Tokens#Speechspeech|speech]] values for the [[Current Token]] use.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [h: names = getSpeech()]
 [foreach(name, names, "<br>"): name]
-</source>
+</syntaxhighlight>
+|changes=
+* '''1.3b49''' - Added {{code|json}} delimiter option.
+}}
+[[Category:Token Function]]
+[[Category:Speech Function]]