getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(3 intermediate revisions by 2 users not shown)
Line 8: Line 8:


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


'''Parameter'''
'''Parameter'''
Line 23: Line 23:
|example=
|example=
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then:
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getTokenHeight("Dragon")]
[r: getTokenHeight("Dragon")]
</source>
</syntaxhighlight>
returns:
returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
50
50
</source>
</syntaxhighlight>


|changes=
|changes=

Latest revision as of 20:57, 14 March 2023

getTokenHeight() Function

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

Usage

getTokenHeight()
getTokenHeight(id)
getTokenHeight(id, mapname)

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:
[r: getTokenHeight("Dragon")]

returns:

50

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.