getTokenHeight

From RPTools Wiki
Revision as of 20:57, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")
Jump to navigation Jump to search

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.