moveToken: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Initial write-up.)
 
(Corrected parameters.)
Line 17: Line 17:
</source>
</source>
'''Parameters'''
'''Parameters'''
* {{code|x}} - The X coordinate to move the token to.
* {{code|x}} - The distance to move the token on the X axis.
* {{code|y}} - The Y coordinate to move the token to.
* {{code|y}} - The distance to move the token on the Y axis.
* {{code|units}} - If set to {{code|false}}({{code|0}}) the distance is in cells. Defaults to Distance Per Cell units.
* {{code|units}} - If set to {{code|false}}({{code|0}}) the distance is in cells. Defaults to Distance Per Cell units.
* {{code|id}} - The id of the token to move, defaults to the current token.
* {{code|id}} - The id of the token to move, defaults to the current token.

Revision as of 03:34, 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 distance to move the token on the X axis.
  • y - The distance to move the token on the Y axis.
  • units - If set to false(0) the distance is in cells. Defaults to Distance Per Cell units.
  • id - The id of the token to move, defaults to the current token.