moveTokenFromMap

From RPTools Wiki
Revision as of 00:38, 20 August 2021 by Melek (talk | contribs) (Add to Map Function category)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

 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 token id or a JSON Array of token ids of the token/s to move.
  • map - A string containing the name of the map that the token is moved from.
  • x - The X coordinate of the current map that the token should be moved to. Defaults to 0.
  • y - The Y 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.


See Also