getSpeechNames: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Returns a list containing the [[ | 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. | ||
| Line 13: | Line 13: | ||
getSpeechNames() | getSpeechNames() | ||
getSpeechNames(delim) | getSpeechNames(delim) | ||
getSpeechNames(delim, tokenRef) | |||
</syntaxhighlight> | </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. | {{code|delim}} is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to {{code|","}} if not specified. | ||
{{code|tokenRef}}Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to list speech names from. | |||
{{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.}} | |||
|example= | |example= | ||
To display the names of all of the [[ | To display the names of all of the [[Introduction_to_Tokens#Speechspeech|speech]] values for the [[Current Token]] use. | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
[h: names = getSpeech()] | [h: names = getSpeech()] | ||
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
jsonthen 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
jsondelimiter option.