getPCNames

From RPTools Wiki
Revision as of 22:17, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page getPCNames to GetPCNames without leaving a redirect: Converting page title to first-letter uppercase)
Jump to navigation Jump to search

getPCNames() Function

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

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

getPCNames()
getPCNames(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 PC tokens on the current map use. 
[h: names = getPCNames()]
[foreach(name, names, "<br>"): name]

See Also

[foreach():]

Version Changes

  • 1.3b49 - Added json delimiter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getPCNames&oldid=12013"