getTokenX: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added examples and some clarification.) |
No edit summary |
||
| Line 16: | Line 16: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|units}} - If set to {{false}}, the coordinate is a location on the grid in '''cells'''. Defaults to {{true}}, where the coordinate is in ''Distance Per Cell'' '''units'''. | * {{code|units}} - If set to {{false}}, the coordinate is a location on the grid in '''cells'''. Defaults to {{true}}, where the coordinate is in ''Distance Per Cell'' '''units'' (in other words 0:distance in cells, 1: distance in pixels)'. | ||
* {{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 10:21, 10 January 2011
getTokenX() Function
• Introduced in version 1.3b51
Gets the X coordinate of a token.
Usage
getTokenX()getTokenX(units)getTokenX(units, id)Parameters
units- If set tofalse(0), the coordinate is a location on the grid in cells'. Defaults totrue(1), where the coordinate is in Distance Per Cell units (in other words 0:distance in cells, 1: distance in pixels)'.id- The id of the token to move, defaults to the Current Token.
Examples
Moves the Current Token down
5 units, and left 10 units.
[h: CurrentX = getTokenX()]
[h: CurrentY = getTokenY()]
[h: NewX = CurrentX + 5]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY)]Moves the Current Token down 5 cells, and left 10 cells.
[h: CurrentX = getTokenX(0)]
[h: CurrentY = getTokenY(0)]
[h: NewX = CurrentX + 5]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY, 0)]