getSelected: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getSelected | |||
|trusted=true | |||
|description= | |||
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. | 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 | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used. | ||
* If the delimiter | * If the delimiter {{code|json}} then a [[Macros:json array|json array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
|usage= | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: macros = getSelected()] | [h: macros = getSelected()] | ||
[h: macros = getSelected(delim)] | [h: macros = getSelected(delim)] | ||
</source> | </source> | ||
delim is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to | {{code|delim}} is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to {{code|","}} if not specified. | ||
|example= | |||
To display the ids of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use. | To display the ids of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 21: | Line 21: | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - Added {{code|json}} delimiter option. | |||
}} | |||
[[Category:Token Function]] | |||
Revision as of 03:40, 8 March 2009
getSelected() Function
Note: This function can only be used in 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
jsonthen a json array is returned. - 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.
Example
To display the ids of all of the selected tokens on the current map use.
[h: ids = getSelected()]
[foreach(id, ids, "<br>"): id]
Version Changes
- 1.3b49 - Added
jsondelimiter option.