moveTokenFromMap: Difference between revisions
Jump to navigation
Jump to search
m (Add to Map Function category) |
m (Name was truncated) |
||
Line 1: | Line 1: | ||
{{stub|Examples of usage, and clearer description.}} | {{stub|Examples of usage, and clearer description.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=moveTokenFromMap | ||
|trusted=true | |trusted=true | ||
|version=1.3b54 | |version=1.3b54 |
Revision as of 17:07, 4 July 2022
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.
moveTokenFromMap() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b54
Moves tokens from a specified map to the current map.
Usage
moveTokenFromMap(id, map)
moveTokenFromMap(id, map, x)
moveTokenFromMap(id, map, x, y)
moveTokenFromMap(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 from.x
- TheX
coordinate of the current map that the token should be moved to. Defaults to 0.y
- TheY
coordinate of the current map that the token should be moved to. Defaults to 0.z
- The z-order that the token should have after being moved. Defaults to the largest of the map.