getSelectedNames: Difference between revisions

Latest revision as of 23:59, 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
-{{ProposedChange}}
+|name=getSelectedNames
-{{TrustedOnlyFunction}}
+|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;
-Returns a [[Macros:string list|string list]] containing the names of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]].
+|usage=
-===Usage===
+<syntaxhighlight lang="mtmacro" line>
-<source lang="mtmacro" line>
+getSelectedNames()
-[h: macros = getSelected()]
+getSelectedNames(delim)
-[h: macros = getSelected(delim)]
+</syntaxhighlight>
-</source>
+{{code|delim}} is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.
-delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' if not specified.
+|example=
+To display the names of all of the selected [[Token:token|token]]s on the current [[Introduction to Mapping|map]] use.
+<syntaxhighlight lang="mtmacro" line>
+[h: names = getSelectedNames()]
+[foreach(name, names, "<br>"): name]
+</syntaxhighlight>
-===Examples===
+|changes=
-To display the names of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use.
+{{change|1.3b49|Added {{code|json}} delimiter option.}}
-<source lang="mtmacro" line>
+{{change|1.3b51|No longer a trusted function.}}
-[h: names = getSelected()]
-[foreach(name, names, "<br>"): name]
+}}
-</source>
+[[Category:Token Function]]