moveTokenFromMap: Difference between revisions
Jump to navigation
Jump to search
m (Adding to Token Function category) |
No edit summary |
||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
moveTokenFromMap(id, map) | |||
moveTokenFromMap(id, map, x) | |||
moveTokenFromMap(id, map, x, y) | |||
moveTokenFromMap(id, map, x, y, z) | moveTokenFromMap(id, map, x, y, z) | ||
</source> | </source> | ||
| Line 14: | Line 17: | ||
{{param|id|The token {{code|id}} or a [[JSON Array]] of token {{code|id}}s of the token/s to move.}} | {{param|id|The token {{code|id}} or a [[JSON Array]] of token {{code|id}}s of the token/s to move.}} | ||
{{param|map|A string containing the name of the map that the token is moved from.}} | {{param|map|A string containing the name of the map that the token is moved from.}} | ||
{{param|x|The {{code|X}} coordinate of the current map that the token should be moved to.}} | {{param|x|The {{code|X}} coordinate of the current map that the token should be moved to. Defaults to 0.}} | ||
{{param|y|The {{code|Y}} coordinate of the current map that the token should be moved to.}} | {{param|y|The {{code|Y}} coordinate of the current map that the token should be moved to. Defaults to 0.}} | ||
{{param|z|The z-order that the token should have after being moved.}} | {{param|z|The z-order that the token should have after being moved. Defaults to the largest of the map.}} | ||
|also= | |also= | ||
Revision as of 14:07, 26 November 2019
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.
moveTokenFrom() 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 tokenidor a JSON Array of tokenids of the token/s to move.map- A string containing the name of the map that the token is moved from.x- TheXcoordinate of the current map that the token should be moved to. Defaults to 0.y- TheYcoordinate 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.