getSelected: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetSelected to getSelected: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 13: | Line 13: | ||
getSelected() | getSelected() | ||
getSelected(delim) | getSelected(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. | {{code|delim}} is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to {{code|","}} if not specified. | ||
| Line 21: | Line 21: | ||
[h: ids = getSelected()] | [h: ids = getSelected()] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Revision as of 19:30, 14 March 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
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
<source lang="mtmacro" line>
getSelected()
getSelected(delim)
</syntaxhighlight>
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.
<source lang="mtmacro" line>
[h: ids = getSelected()]
[foreach(id, ids, "
"): id]
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.3b51 - No longer a trusted function.