getTokenY

getTokenY() Function

• Introduced in version 1.3b51

Gets the Y coordinate for a token.

Usage

getTokenY()

getTokenY(units)

getTokenY(units, id)

Parameters

• units - If set to false(0), the coordinate is a location on the grid in cells. Defaults to true(1), where the coordinate is in Distance Per Cell units.
• 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)]

See Also

moveToken(), getTokenX()