moveToken: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Changed "Macros:Variables:string" to "string" so redirect can be removed)
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=moveToken
|name=moveToken
Line 7: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
moveToken(x, y)
moveToken(x, y)
</source>
<source lang="mtmacro" line>
moveToken(x, y, units)
moveToken(x, y, units)
</source>
<source lang="mtmacro" line>
moveToken(x, y, units, id)
moveToken(x, y, units, id)
</source>
</syntaxhighlight>
'''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|false}}({{code|0}}), the coordinates are a location on the grid. Defaults to coordinates measured in Distance Per Cell units.
* {{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|id}} - The id [[Macros:Variables:string|string]] of the token to move, defaults to the current token.
* {{code|id}} - The id [[string]] of the token to move, defaults to the [[Current Token]].{{TrustedParameter}}
&nbsp;
<!-- 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]]

Revision as of 07:13, 23 November 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 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 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)]

See Also