getPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==Function getPCs==
==Function getPCs==
{{ProposedChange}}
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}


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

Revision as of 15:07, 6 December 2008

Function getPCs

This function can only be called from a trusted macro


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

[h: macros = getPCs()]
[h: macros = getPCs(delim)]

delim is the delimiter used to separate the values in the string list which defaults to ',' if not specified.


Examples

To display the ids of all of the PC tokens on the current map use.

[h: ids = getPCs()]
[foreach(id, ids, "<br>"): id]