getTokenNativeHeight: Difference between revisions
Jump to navigation
Jump to search
(add getTokenNativeHeight) |
No edit summary |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenNativeHeight() | getTokenNativeHeight() | ||
getTokenNativeHeight( | getTokenNativeHeight(tokenRef) | ||
</ | getTokenNativeHeight(tokenRef, mapRef) | ||
</syntaxhighlight> | |||
'''Parameter''' | '''Parameter''' | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for its height, defaults to the [[Current Token]].}} | ||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
'''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 23:59, 2 September 2024
getTokenNativeHeight() Function
• Introduced in version 1.5.1
Retrieves the token's native image height in pixels (native size).
Usage
getTokenNativeHeight()
getTokenNativeHeight(tokenRef)
getTokenNativeHeight(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor Token Name of the token to check for its height, defaults to the Current Token.mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
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:
120See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.