moveToken

moveToken() Function

• Introduced in version 1.3b51

Move a token to a new location.

Usage

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. 

 

Examples

Moves the Current Token down 5 units, and left 10 units.

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

Moves the Current Token down 5 cells, and left 10 cells.

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

See Also

getTokenX(),

getTokenY(), moveTokenToMap(),

moveTokenFromMap()