getTokenWidth: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetTokenWidth to getTokenWidth: Converting page titles to lowercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenWidth() | getTokenWidth() | ||
getTokenWidth(id) | getTokenWidth(id) | ||
| Line 23: | Line 23: | ||
|example= | |example= | ||
Assuming a token called {{code|"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")] | ||
</source> | </source> | ||
returns: | returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
50 | 50 | ||
</source> | </source> | ||
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
<syntaxhighlight lang="mtmacro" line> getTokenWidth() getTokenWidth(id) getTokenWidth(id, mapname) </source>
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:
<syntaxhighlight lang="mtmacro" line> [r: getTokenWidth("Dragon")] </source> returns: <syntaxhighlight lang="mtmacro" line> 50
</source>See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.