getSelected: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getSelected== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a string list containing the ids of the selected Token:NPC tokens on the current [[...) |
No edit summary |
||
| Line 3: | Line 3: | ||
{{TrustedOnlyFunction}} | {{TrustedOnlyFunction}} | ||
Returns a [[Macros:string list|string list]] containing the ids of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. | Returns a [[Macros:string list|string list]] containing the ids of the selected [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. | ||
===Usage=== | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: macros = getSelected()] | [h: macros = getSelected()] | ||
Revision as of 23:40, 1 December 2008
Function getSelected
Note: This refers to a proposed change that has not been implemented in the main code base yet.
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]