getSelectedNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Removed trusted.) |
Verisimilar (talk | contribs) m (Correcting JSON Array link.) |
||
| Line 5: | Line 5: | ||
Returns a list containing the names of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. The type of the value returned depends on the delimiter parameter. | Returns a list containing the names of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. 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 [[ | * 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. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
Revision as of 22:01, 4 April 2009
getSelectedNames() Function
• Introduced in version 1.3b48
Returns a list containing the names of the selected NPC tokens on the current map. 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
getSelected()
getSelected(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 selected tokens on the current map use.
[h: names = getSelected()]
[foreach(name, names, "<br>"): name]
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.3b51 - No longer a trusted function.