getPCNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getPCNames== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a string list containing the names of the Token:PC tokens on the current [[Map:map|m...)
 
Line 1: Line 1:
==Function getPCNames==
==Function getPCNames==
{{ProposedChange}}
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}


Returns a [[Macros:string list|string list]] containing the names of the [[Token:PC token|PC token]]s on the current [[Map:map|map]].  
Returns a [[Macros:string list|string list]] containing the names of the [[Token:PC token|PC token]]s on the current [[Map:map|map]].  

Revision as of 15:07, 6 December 2008

Function getPCNames

This function can only be called from a trusted macro


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

[h: macros = getPCNames()]
[h: macros = getPCNames(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 PC tokens on the current map use.

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