moveToken: Difference between revisions
Jump to navigation
Jump to search
(Updated units explanation for clarity. Removed Clarify tag.) |
No edit summary |
||
| (15 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=moveToken | |name=moveToken | ||
| Line 7: | 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, tokenRef) | |||
</syntaxhighlight> | |||
moveToken(x, y, units, | |||
</ | |||
'''Parameters''' | '''Parameters''' | ||
* {{code|x}} - The X coordinate to move the token to. | * {{code|x}} - The X coordinate to move the token to. | ||
* {{code|y}} - The Y coordinate to move the token to. | * {{code|y}} - The Y coordinate to move the token to. | ||
* {{code|units}} - If set to {{ | * {{code|units}} - If set to {{false}}, the coordinates are a location on the grid in '''cells'''. Defaults to {{true}}, where the coordinates are in ''Distance Per Cell'' '''pixels'''. | ||
* {{code| | * {{code|tokenRef}} - Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to move, defaults to the [[Current Token]].{{TrustedParameter}} | ||
{{Note|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.}} | |||
| |||
<!-- The 'nbsp' is needed to close the DIV --> | |||
|examples= | |||
Moves the [[Current Token]] right {{code|5}} '''pixels''', and up {{code|10}} '''pixels'''. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: CurrentX = getTokenX()] | |||
[h: CurrentY = getTokenY()] | |||
[h: NewX = CurrentX + 5] | |||
[h: NewY = CurrentY - 10] | |||
[h: moveToken(NewX, NewY)] | |||
</syntaxhighlight> | |||
Moves the [[Current Token]] right {{code|5}} '''cells''', and up {{code|10}} '''cells'''. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: CurrentX = getTokenX(0)] | |||
[h: CurrentY = getTokenY(0)] | |||
[h: NewX = CurrentX + 5] | |||
[h: NewY = CurrentY - 10] | |||
[h: moveToken(NewX, NewY, 0)] | |||
</syntaxhighlight> | |||
|also= | |||
{{func|getTokenX}}, | |||
{{func|getTokenY}}, | |||
{{func|moveTokenToMap}}, | |||
{{func|moveTokenFromMap}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 17 May 2024
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, tokenRef)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.tokenRef- Either the tokenidor Token Name of the token to move, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
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.
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)]