From RPTools Wiki
Jump to navigation Jump to search

getTokenMap() Function

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

Introduced in version 1.5.11
Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.


getTokenMap(tokenRef, delim)

Parameters Parameters

  • tokenRef - Either the name of the token or the ID.
  • delim - The delimiter used in the string list returned, defaults to ",". If set to json, then a JSON array is returned.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


Suppose a token named "Dragon" is on two maps, "Grasslands" and "Arid". The command
[r: getTokenMap("Dragon", "json")]

returns the JSON Array: