getSelectedNames: Difference between revisions

Latest revision as of 17:06, 20 April 2023

getSelectedNames() Function

• Introduced in version 1.3b48

Returns a list containing the names of the selected 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 json then a JSON Array is returned.
Otherwise a string list is returned with the delimiter passed in.

Usage

getSelectedNames()
getSelectedNames(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 = getSelectedNames()]
[foreach(name, names, "<br>"): name]

Version Changes

1.3b49 - Added json delimiter option.
1.3b51 - No longer a trusted function.

@@ Line 1: / Line 1: @@
-==Function getSelectedNames==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getSelectedNames
+|version=1.3b48
+|description=
+Returns a list containing the names of the selected [[Token|token]]s on the current [[Introduction to Mapping|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 {{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>
+getSelectedNames()
+getSelectedNames(delim)
+</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.
-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.
+|example=
-* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
+To display the names of all of the selected [[Token:token|token]]s on the current [[Introduction to Mapping|map]] use.
-* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+<syntaxhighlight lang="mtmacro" line>
-* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
+[h: names = getSelectedNames()]
+[foreach(name, names, "<br>"): name]
+</syntaxhighlight>
-===Usage===
+|changes=
-<source lang="mtmacro" line>
+{{change|1.3b49|Added {{code|json}} delimiter option.}}
-[h: macros = getSelected()]
+{{change|1.3b51|No longer a trusted function.}}
-[h: macros = getSelected(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===
+[[Category:Token Function]]
-To display the names of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use.
-<source lang="mtmacro" line>
-[h: names = getSelected()]
-[foreach(name, names, "<br>"): name]
-</source>