moveTokenToMap: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Add to Map Function category) |
||
Line 25: | Line 25: | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]][[Category:Map Function]] |
Revision as of 00:37, 20 August 2021
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage, and clearer description.
moveTokenToMap() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b54
Moves tokens from the current map to a specified map.
Usage
moveTokenToMap(id, map)
moveTokenToMap(id, map, x)
moveTokenToMap(id, map, x, y)
moveTokenToMap(id, map, x, y, z)
Parameters
id
- The tokenid
or a JSON Array of tokenid
s of the token/s to move.map
- A string containing the name of the map that the token is moved to.x
- TheX
coordinate of the map that the token should be moved to. Default to 0.y
- TheY
coordinate of the map that the token should be moved to. Default to 0.z
- The z-order that the token should have after being moved. Defaults to the largest of the map.