getSelected
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.
Token: A visual marker representing a character, monster, or NPCString List: A string containing a list of items in the format "item1, item2, item3,..."Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.