getTokenY: Difference between revisions

Revision as of 12:01, 29 April 2009

• Introduced in version 1.3b51

Gets the Y coordinate for a token.

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.

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)]

@@ Line 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=getTokenY
@@ Line 17: / Line 16: @@
 </source>
 '''Parameters'''
-* {{code|units}} - If set to {{code|false}}({{code|0}}) then the distance is returned in cells. Default returns 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'''.
-* {{code|id}} - The id of the token to get the coordinate of, defaults to the current token.
+* {{code|id}} - The id of the token to move, defaults to the [[Current Token]].
+|examples=
+Moves the [[Current Token]] down {{code|5}} '''units''', and left {{code|10}} '''units'''.
+<source lang="mtmacro" line>
+[h: CurrentX = getTokenX()]
+[h: CurrentY = getTokenY()]
+[h: NewX = CurrentX + 5]
+[h: NewY = CurrentY - 10]
+[h: moveToken(NewX, NewY)]
+</source>
+Moves the [[Current Token]] down {{code|5}} '''cells''', and left {{code|10}} '''cells'''.
+<source lang="mtmacro" line>
+[h: CurrentX = getTokenX(0)]
+[h: CurrentY = getTokenY(0)]
+[h: NewX = CurrentX + 5]
+[h: NewY = CurrentY - 10]
+[h: moveToken(NewX, NewY, 0)]
+</source>
+|also=
+{{func|moveToken}},
+{{func|getTokenX}}
 }}
 [[Category:Distance Function]]