getSelected: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getSelected() | getSelected() | ||
getSelected(delim) | getSelected(delim) | ||
| Line 18: | Line 18: | ||
|example= | |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 [[Map:map|map]] use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: ids = getSelected()] | [h: ids = getSelected()] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
Revision as of 20:58, 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
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
jsondelimiter option. - 1.3b51 - No longer a trusted function.