moveToken: Difference between revisions

Revision as of 07:02, 25 August 2022

• Introduced in version 1.3b51

Move a token to a new location.

moveToken(x, y)
moveToken(x, y, units)
moveToken(x, y, units, id)

Parameters

x - The X coordinate to move the token to.
y - The Y coordinate to move the token to.
units - If set to false(0), the coordinates are a location on the grid in cells. Defaults to true(1), where the coordinates are in Distance Per Cell pixels.
id - The id string of the token to move, defaults to the Current Token.
Note: This parameter can only be used in a Trusted Macro.

Moves the Current Token right 5 units, and up 10 units.

[h: CurrentX = getTokenX()]
[h: CurrentY = getTokenY()]
[h: NewX = CurrentX + 5]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY)]

Moves the Current Token right 5 cells, and up 10 cells.

[h: CurrentX = getTokenX(0)]
[h: CurrentY = getTokenY(0)]
[h: NewX = CurrentX + 5]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY, 0)]

@@ Line 19: / Line 19: @@
 <!-- The 'nbsp' is needed to close the DIV -->
 |examples=
-Moves the [[Current Token]] down {{code|5}} '''units''', and left {{code|10}} '''units'''.
+Moves the [[Current Token]] right {{code|5}} '''units''', and up {{code|10}} '''units'''.
 <source lang="mtmacro" line>
 [h: CurrentX = getTokenX()]
@@ Line 28: / Line 28: @@
 </source>
-Moves the [[Current Token]] down {{code|5}} '''cells''', and left {{code|10}} '''cells'''.
+Moves the [[Current Token]] right {{code|5}} '''cells''', and up {{code|10}} '''cells'''.
 <source lang="mtmacro" line>
 [h: CurrentX = getTokenX(0)]