getSpeechNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version.) |
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
||
| Line 3: | Line 3: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Returns a list containing the [[Token:speech|speech]] names of the [[ | Returns a list containing the [[Token: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 [[Macros:json array|json array]] is returned. | * If the delimiter {{code|json}} then a [[Macros:json array|json array]] is returned. | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
To display the names of all of the [[Token:speech|speech]] values for the [[ | To display the names of all of the [[Token:speech|speech]] values for the [[Current Token]] use. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: names = getSpeech()] | [h: names = getSpeech()] | ||
Revision as of 21:25, 4 April 2009
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)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
jsondelimiter option.