getTokens: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Verisimilar (talk | contribs) |
||
Line 19: | Line 19: | ||
You can use the following code to print out the ids of all of the [[Token:token|token]]s on the current [[Map:map|map]]. | You can use the following code to print out the ids of all of the [[Token:token|token]]s on the current [[Map:map|map]]. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: ids = | [h: ids = getTokens()] | ||
[foreach( | [foreach(id, ids, "<br>"): id] | ||
</source> | </source> |
Revision as of 22:56, 25 February 2009
Function getTokens
This function can only be called from a trusted macro
Gets a list containing the ids of all the 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: player = getTokens()]
[h: player = getTokens(delim)]
If delim is specified then it is used to separate the values in the list, if it is not specified then it defaults to ','.
Examples
You can use the following code to print out the ids of all of the tokens on the current map.
[h: ids = getTokens()]
[foreach(id, ids, "<br>"): id]