getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTokenHeight to getTokenHeight: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 12: Line 12:
getTokenHeight(id)
getTokenHeight(id)
getTokenHeight(id, mapname)
getTokenHeight(id, mapname)
</source>
</syntaxhighlight>


'''Parameter'''
'''Parameter'''
Line 25: Line 25:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r: getTokenHeight("Dragon")]
[r: getTokenHeight("Dragon")]
</source>
</syntaxhighlight>
returns:
returns:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
50
50
</source>
</syntaxhighlight>


|changes=
|changes=

Revision as of 19:35, 14 March 2023

getTokenHeight() Function

Introduced in version 1.3b89
Retrieves the token's image height in pixels (boundary size).

Usage

<source lang="mtmacro" line> getTokenHeight() getTokenHeight(id) getTokenHeight(id, mapname) </syntaxhighlight>

Parameter

  • id - The token id of the token to check for its height, defaults to the Current Token.
  • mapname - The name of the map to find the token. Defaults to the current map.


Result
The token's boundary (image) height in pixels.

Example

Assuming a token called "Dragon", medium size, on a 50px square grid, then:

<source lang="mtmacro" line> [r: getTokenHeight("Dragon")] </syntaxhighlight> returns: <source lang="mtmacro" line> 50

</syntaxhighlight>

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.