getSelected: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
{{TrustedOnlyFunction}} | {{TrustedOnlyFunction}} | ||
Returns a | Returns a list containing the ids of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | |||
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)''' | |||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | |||
===Usage=== | ===Usage=== | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
Revision as of 14:23, 24 December 2008
Function getSelected
This function can only be called from a trusted macro
Returns a list containing the ids of the selected NPC 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. (as of MapTool 1.3b49)
- Otherwise a string list is returned with the delimiter passed in.
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]