getNPC

From RPTools Wiki
Revision as of 22:54, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page GetNPC to getNPC: Converting page titles to lowercase)
Jump to navigation Jump to search

getNPC() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b48
Returns a list containing the ids 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

getNPC()
getNPC(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 NPC tokens on the current map use. 
[h: ids = getNPC()]
[foreach(id, ids, "<br>"): id]

See Also

[foreach():]

Version Changes

  • 1.3b49 - Added json delimiter option.
Retrieved from "https://rptools.hyperbooks.com/index.php?title=getNPC&oldid=12809"