getTokenNativeHeight: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 16: | Line 16: | ||
'''Parameter''' | '''Parameter''' | ||
{{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|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|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name 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.}} | {{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.}} |
Revision as of 22:57, 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, mapname)
Parameter
tokenRef
- Either the tokenid
or Token Name 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.
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:
120
See Also
Version Changes
- 1.5.4 - Added
mapname
parameter option.