getSelected: Difference between revisions

Latest revision as of 23:59, 20 April 2023

getSelected() Function

• Introduced in version 1.3b48

Returns a list containing the ids 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

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 ids of all of the selected tokens on the current map use.

[h: ids = getSelected()]
[foreach(id, ids, "<br>"): id]

Version Changes

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

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