moveToken: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
moveToken(x, y) | moveToken(x, y) | ||
moveToken(x, y, units) | moveToken(x, y, units) | ||
moveToken(x, y, units, id) | moveToken(x, y, units, id) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|x}} - The X coordinate to move the token to. | * {{code|x}} - The X coordinate to move the token to. | ||
| Line 20: | Line 20: | ||
|examples= | |examples= | ||
Moves the [[Current Token]] right {{code|5}} '''pixels''', and up {{code|10}} '''pixels'''. | Moves the [[Current Token]] right {{code|5}} '''pixels''', and up {{code|10}} '''pixels'''. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: CurrentX = getTokenX()] | [h: CurrentX = getTokenX()] | ||
[h: CurrentY = getTokenY()] | [h: CurrentY = getTokenY()] | ||
| Line 26: | Line 26: | ||
[h: NewY = CurrentY - 10] | [h: NewY = CurrentY - 10] | ||
[h: moveToken(NewX, NewY)] | [h: moveToken(NewX, NewY)] | ||
</ | </syntaxhighlight> | ||
Moves the [[Current Token]] right {{code|5}} '''cells''', and up {{code|10}} '''cells'''. | Moves the [[Current Token]] right {{code|5}} '''cells''', and up {{code|10}} '''cells'''. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: CurrentX = getTokenX(0)] | [h: CurrentX = getTokenX(0)] | ||
[h: CurrentY = getTokenY(0)] | [h: CurrentY = getTokenY(0)] | ||
| Line 35: | Line 35: | ||
[h: NewY = CurrentY - 10] | [h: NewY = CurrentY - 10] | ||
[h: moveToken(NewX, NewY, 0)] | [h: moveToken(NewX, NewY, 0)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 23:03, 14 March 2023
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 tofalse(0), the coordinates are a location on the grid in cells. Defaults totrue(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 right
5 pixels, and up 10 pixels.
[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)]