getTokenWidth: Difference between revisions
Jump to navigation
Jump to search
(More explicit description and usage) |
No edit summary |
||
| (11 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenWidth | |name=getTokenWidth | ||
| Line 6: | Line 5: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
Retrieves the token's image width in pixels (boundary size). | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenWidth() | getTokenWidth() | ||
getTokenWidth( | getTokenWidth(tokenRef) | ||
</ | getTokenWidth(tokenRef, mapRef) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
{{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 boundary (image) width in pixels. | The token's boundary (image) width in pixels. | ||
|example= | |example= | ||
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then: | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
[ | [r: getTokenWidth("Dragon")] | ||
</syntaxhighlight> | |||
</ | returns: | ||
<syntaxhighlight lang="mtmacro" line> | |||
< | 50 | ||
</syntaxhighlight> | |||
</ | |||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
{{func|getTokenHeight}} | {{func|getTokenHeight}} | ||
{{func|getTokenNativeHeight}} | |||
{{func|getTokenNativeWidth}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 14 May 2024
getTokenWidth() Function
• Introduced in version 1.3b89
Retrieves the token's image width in pixels (boundary size).
Usage
getTokenWidth()
getTokenWidth(tokenRef)
getTokenWidth(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor Token Name of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
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 boundary (image) width in pixels.
Example
Assuming a token called
"Dragon", medium size, on a 50px square grid, then:
[r: getTokenWidth("Dragon")]returns:
50See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.