getSelectedNames

From RPTools Wiki
Revision as of 14:23, 24 December 2008 by Craig (talk | contribs)
Jump to navigation Jump to search

Function getSelectedNames

This function can only be called from a trusted macro


Returns a list containing the names 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. (as of MapTool 1.3b49)
  • Otherwise a string list is returned with the delimiter passed in.

Usage

[h: macros = getSelected()]
[h: macros = getSelected(delim)]

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


Examples

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

[h: names = getSelected()]
[foreach(name, names, "<br>"): name]
Retrieved from "https://wiki.rptools.info/index.php?title=getSelectedNames&oldid=787"