getTokenX

From RPTools Wiki
Revision as of 23:14, 9 March 2009 by Verisimilar (talk | contribs) (getDistanceToX moved to getTokenX: Wrong name.)
Jump to navigation Jump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getDistanceToX() Function

Introduced in version 1.3b51
Gets the X coordinate of a token.

Usage

getDistanceToX()
getDistanceToX(units)
getDistanceToX(units, id)

Parameters

  • units - If set to false(0) the function will return the distance in cells. The default returns Distance Per Cell units.
  • id - The ID of the token to get the X coordinate of, defaults to the current token.