getTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Added version.)
Line 2: Line 2:
|name=getTokens
|name=getTokens
|trusted=true
|trusted=true
|version=1.3b48
|description=
|description=
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.  
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.  
Line 10: Line 11:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: player = getTokens()]
getTokens()
[h: player = getTokens(delim)]
getTokens(delim)
</source>
</source>



Revision as of 13:06, 10 March 2009

getTokens() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
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.
  • Otherwise a string list is returned with the delimiter passed in.

Usage

getTokens()
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 ",".

Example

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]


Version Changes

  • 1.3b49 - Added json delimiter option.