getSelectedNames: Difference between revisions

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


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

Revision as of 15:08, 6 December 2008

Function getSelectedNames

This function can only be called from a trusted macro


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

Usage

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

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