getTokenNativeHeight: Difference between revisions
Jump to navigation
Jump to search
(add getTokenNativeHeight) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
(5 intermediate revisions by 4 users not shown) | |||
Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenNativeHeight() | getTokenNativeHeight() | ||
getTokenNativeHeight(id) | getTokenNativeHeight(id) | ||
</ | getTokenNativeHeight(id, mapname) | ||
</syntaxhighlight> | |||
'''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 /> | ||
The token's native(image) height in pixels. | The token's native(image) height in pixels. | ||
|example= | |example= | ||
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, | Assuming a token called {{code|"Dragon"}}, with 120px native image height, medium size, on a 50px square grid , then: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: getTokenNativeHeight("Dragon")] | [r: getTokenNativeHeight("Dragon")] | ||
</ | </syntaxhighlight> | ||
returns: | returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
120 | 120 | ||
</ | </syntaxhighlight> | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= |
Latest 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.