getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(add native size functions)
No edit summary
Line 11: Line 11:
getTokenHeight()
getTokenHeight()
getTokenHeight(id)
getTokenHeight(id)
getTokenHeight(id, mapname)
</source>
</source>


'''Parameter'''
'''Parameter'''
{{param|id|The token id of the token to check for its height, defaults to the [[Current Token]].}}
{{param|id|The token id of the token to check for its height, defaults to the [[Current Token]].}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


'''Result'''<br />
'''Result'''<br />
Line 27: Line 30:
50
50
</source>
</source>
|changes=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


|also=
|also=

Revision as of 20:54, 15 August 2019

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.