moveToken: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 19: | Line 19: | ||
* {{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 in Distance Per Cell units. | * {{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|id}} - The id [[Macros:Variables:string|string]] of the token to move, defaults to the current token. | * {{code|id}} - The id [[Macros:Variables:string|string]] of the token to move, defaults to the current token. | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] |
Revision as of 13:51, 11 March 2009
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
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. Defaults to coordinates measured in Distance Per Cell units.id
- The id string of the token to move, defaults to the current token.