getSelected: Difference between revisions

Revision as of 13:11, 10 March 2009

Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b48

Returns a list containing the ids 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 json then a json array is returned.
Otherwise a string list is returned with the delimiter passed in.

getSelected()
getSelected(delim)

delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.

To display the ids of all of the selected tokens on the current map use.

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

@@ Line 2: / Line 2: @@
 |name=getSelected
 |trusted=true
+|version=1.3b48
 |description=
 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.
@@ Line 10: / Line 11: @@
 |usage=
 <source lang="mtmacro" line>
-[h: macros = getSelected()]
+getSelected()
-[h: macros = getSelected(delim)]
+getSelected(delim)
 </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.