getTokenX: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
 
(16 intermediate revisions by 7 users not shown)
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenX()
getTokenX()
</source>
<source lang="mtmacro" line>
getTokenX(units)
getTokenX(units)
</source>
getTokenX(units, tokenRef)
<source lang="mtmacro" line>
getTokenX(units, tokenRef, mapRef)
getTokenX(units, id)
</syntaxhighlight>
</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'' (in other words 0:distance in cells, 1: distance in pixels)'.
{{param|units|If set to {{false}}, the coordinate is a location on the grid in number of ''cells''. Defaults to {{true}}, where the coordinate is in ''number of Pixels'' (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]].
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to return the X coordinate of, defaults to the [[Current Token]].}}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


'''Which coordinate is returned for tokens larger then one cell'''
'''Which coordinate is returned for tokens larger then one cell'''
* With the exception of one case the coordinates of the cell are given where the UPPER LEFT CORNER of the token is in at that moment.  
{{ProposedChange|The {{mark}}marked exception will disappear.}}
* The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND '''NOT''' 'On Background Layer'. In that particular case the coordinates of the cell where the CENTRE of the image of the token is at.  
* With the exception of {{mark}}one case the coordinates of the cell are given where the UPPER LEFT CORNER of the the image of the token is in at that moment.  
* {{mark}}The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND '''NOT''' 'On Background Layer'. In that particular case the coordinates of the cell where the upper left corner of the FOOTPRINT (NOT image) of the token is at. The footprint can be recognized when you move the token on the Token layer, it will leave the white marker on the field. The footprint can be the same size as the image and it is if a preset size is used. With freesize however the size of the footprint is either the original size of the image OR when you have used a preset (e.g. 'large') it will have the size of the preset as footprint.  
* Note that if you rotate the image such that the image is no longer in the upper left corner, the upper left corner of its '''native position''' is still returned as its coordinate.  
* Note that if you rotate the image such that the image is no longer in the upper left corner, the upper left corner of its '''native position''' is still returned as its coordinate.  


|examples=
|examples=
Moves the [[Current Token]] down {{code|5}} '''units''', and left {{code|10}} '''units'''.
Moves the [[Current Token]] right {{code|5}} '''pixels''', and up {{code|10}} '''pixels'''.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: CurrentX = getTokenX()]
[h: CurrentX = getTokenX()]
[h: CurrentY = getTokenY()]
[h: CurrentY = getTokenY()]
Line 32: Line 32:
[h: NewY = CurrentY - 10]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY)]
[h: moveToken(NewX, NewY)]
</source>
</syntaxhighlight>


Moves the [[Current Token]] down {{code|5}} '''cells''', and left {{code|10}} '''cells'''.
Moves the [[Current Token]] right {{code|5}} '''cells''', and up {{code|10}} '''cells'''.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: CurrentX = getTokenX(0)]
[h: CurrentX = getTokenX(0)]
[h: CurrentY = getTokenY(0)]
[h: CurrentY = getTokenY(0)]
Line 41: Line 41:
[h: NewY = CurrentY - 10]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY, 0)]
[h: moveToken(NewX, NewY, 0)]
</source>
</syntaxhighlight>


|also=
|also=
{{func|moveToken}},  
{{func|moveToken}},  
{{func|getTokenY}}
{{func|getTokenY}},
{{func|getZoom}},
{{func|setZoom}}.
 
|changes=
{{change|1.5.8|Added {{code|mapname}} parameter option.}}


}}
}}
[[Category:Distance Function]]
[[Category:Distance Function]] [[Category:Token Function]]

Latest revision as of 23:59, 14 May 2024

getTokenX() Function

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

Usage

getTokenX()
getTokenX(units)
getTokenX(units, tokenRef)
getTokenX(units, tokenRef, mapRef)

Parameters

  • units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.
  • tokenRef - Either the token id or Token Name of the token to return the X coordinate of, defaults to the Current Token.
  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


Which coordinate is returned for tokens larger then one cell

 Note: This refers to a proposed change that has not been implemented in the main code base yet.
 Details:
The ∗ marked exception will disappear.

  • With the exception of

∗ one case the coordinates of the cell are given where the UPPER LEFT CORNER of the the image of the token is in at that moment.

∗ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND NOT 'On Background Layer'. In that particular case the coordinates of the cell where the upper left corner of the FOOTPRINT (NOT image) of the token is at. The footprint can be recognized when you move the token on the Token layer, it will leave the white marker on the field. The footprint can be the same size as the image and it is if a preset size is used. With freesize however the size of the footprint is either the original size of the image OR when you have used a preset (e.g. 'large') it will have the size of the preset as footprint.

  • Note that if you rotate the image such that the image is no longer in the upper left corner, the upper left corner of its native position is still returned as its coordinate.

Examples

Moves the Current Token right 5 pixels, and up 10 pixels. 
[h: CurrentX = getTokenX()]
[h: CurrentY = getTokenY()]
[h: NewX = CurrentX + 5]
[h: NewY = CurrentY - 10]
[h: moveToken(NewX, NewY)]

Moves the Current Token right 5 cells, and up 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(),

getTokenY(), getZoom(),

setZoom().

Version Changes

  • 1.5.8 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getTokenX&oldid=35096"