getTokenWidth: Difference between revisions
Jump to navigation
Jump to search
(add native size functions) |
No edit summary |
||
| Line 11: | Line 11: | ||
getTokenWidth() | getTokenWidth() | ||
getTokenWidth(id) | getTokenWidth(id) | ||
getTokenWidth(id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}} | {{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 /> | ||
| Line 27: | Line 30: | ||
50 | 50 | ||
</source> | </source> | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
Revision as of 20:53, 15 August 2019
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.