getTokenWidth: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (7 intermediate revisions by 6 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(id) | getTokenWidth(id) | ||
</ | getTokenWidth(id, mapname) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}} | {{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
'''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 "Dragon", medium size, on a 50px square grid, then | Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: getTokenWidth("Dragon")] | [r: getTokenWidth("Dragon")] | ||
</ | </syntaxhighlight> | ||
returns: | returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
50 | 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]] | ||
Revision as of 21:05, 14 March 2023
getTokenWidth() Function
• Introduced in version 1.3b89
Retrieves the token's image width in pixels (boundary size).
Usage
getTokenWidth()
getTokenWidth(id)
getTokenWidth(id, mapname)Parameters
id- The token id of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.
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.