moveTokenFromMap: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Corrected usage syntax.)
No edit summary
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{stub|Examples of usage, and clearer description.}}
{{stub|Examples of usage, and clearer description.}}
{{MacroFunction
{{MacroFunction
|name=moveTokenFrom
|name=moveTokenFromMap
|trusted=true
|trusted=true
|version=1.3b54
|version=1.3b54
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight 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>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{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=
Line 22: Line 25:


}}
}}
[[Category:Token Function]][[Category:Map Function]]

Revision as of 23:03, 14 March 2023

 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 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