getSelected: Difference between revisions

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



Revision as of 02:53, 23 December 2008

Function getSelected

This function can only be called from a trusted macro

Returns a string list containing the ids 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 ids of all of the selected tokens on the current map use.

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