getTokens: Difference between revisions

Revision as of 14:22, 24 December 2008

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.

[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 ','.

You can use the following code to print out the ids of all of the tokens on the current map.

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

@@ Line 3: / Line 3: @@
-Gets a [[Macros:string list|string list]] containing the ids of all the [[Token:token|token]]s on the current [[Map:map|map]].
+Gets a list containing the ids of all the [[Token:token|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===