getNPCNames
getNPCNames() Function
• Introduced in version 1.3b48
Returns a list containing the names of the 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.
Usage
[h: macros = getNPCNames()]
[h: macros = getNPCNames(delim)]
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.
Example
To display the names of all of the NPC tokens on the current map use.
[h: names = getNPCNames()]
[foreach(name, names, "<br>"): name]
See Also
[foreach():]
Version Changes
- 1.3b49 - Added
json delimiter option.
Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.String 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.