getTokenMap

From RPTools Wiki
Jump to navigationJump to search

getTokenMap() Function

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.

Usage

getTokenMap(name/ID)
getTokenMap(name/ID, delim)

Parameters Parameters

  • name/ID - 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.

Example

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

returns the JSON Array:

["Grasslands","Arid"]