getNPCNames

From RPTools Wiki
Revision as of 22:54, 1 December 2008 by Craig (talk | contribs) (New page: ==Function getNPCNames== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a Macros:string list containing the names of the Token:NPC tokens on the current Map:map. <sour...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function getNPCNames

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

This function can only be called from a trusted macro

Returns a string list containing the names of the NPC tokens on the current map.

[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.


Examples

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

[h: names = getNPCNames()]
[foreach(name, names, "<br>"): name]