getTokenWidth: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
No edit summary |
||
Line 10: | Line 10: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
getTokenWidth() | getTokenWidth() | ||
getTokenWidth( | getTokenWidth(tokenRef) | ||
getTokenWidth( | getTokenWidth(tokenRef, mapname) | ||
</syntaxhighlight> | </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|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.}} | |||
'''Result'''<br /> | '''Result'''<br /> |
Revision as of 16:38, 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, mapname)
Parameters
tokenRef
- Either the tokenid
or 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.
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 boundary (image) width in pixels.
Example
Assuming a token called
"Dragon"
, medium size, on a 50px square grid, then:
[r: getTokenWidth("Dragon")]
returns:
50
See Also
Version Changes
- 1.5.4 - Added
mapname
parameter option.