getTokenMap: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
m (Text replacement - "source>" to "syntaxhighlight>")
Line 10: Line 10:
getTokenMap(name/ID)
getTokenMap(name/ID)
getTokenMap(name/ID, delim)
getTokenMap(name/ID, delim)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
'''Parameters'''
'''Parameters'''
Line 20: Line 20:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getTokenMap("Dragon", "json")]
[r: getTokenMap("Dragon", "json")]
</source>
</syntaxhighlight>
returns the JSON Array:
returns the JSON Array:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
["Grasslands","Arid"]
["Grasslands","Arid"]
</source>
</syntaxhighlight>
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]
[[Category:Map Function]]
[[Category:Map Function]]

Revision as of 20:45, 14 March 2023

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.

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"]