getTokenNativeHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenNativeHeight()
getTokenNativeHeight()
getTokenNativeHeight(id)
getTokenNativeHeight(id)
Line 23: Line 23:
|example=
|example=
Assuming a token called {{code|"Dragon"}}, with 120px native image height, medium size, on a 50px square grid , then:
Assuming a token called {{code|"Dragon"}}, with 120px native image height, medium size, on a 50px square grid , then:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getTokenNativeHeight("Dragon")]
[r: getTokenNativeHeight("Dragon")]
</syntaxhighlight>
</syntaxhighlight>
returns:
returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
120
120
</syntaxhighlight>
</syntaxhighlight>

Revision as of 21:00, 14 March 2023

getTokenNativeHeight() Function

Introduced in version 1.5.1
Retrieves the token's native image height in pixels (native size).

Usage

getTokenNativeHeight()
getTokenNativeHeight(id)
getTokenNativeHeight(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 native(image) height in pixels.

Example

Assuming a token called "Dragon", with 120px native image height, medium size, on a 50px square grid , then:
[r: getTokenNativeHeight("Dragon")]

returns:

120

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.