moveTokenFromMap

 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(tokenRef, map)
moveTokenFromMap(tokenRef, map, x)
moveTokenFromMap(tokenRef, map, x, y)
moveTokenFromMap(tokenRef, map, x, y, z)

Parameters

• tokenRef - Either the token id or Token Name of the token 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.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

See Also

moveTokenToMap()