getTokenWidth: Difference between revisions

Latest revision as of 23:59, 14 May 2024

• Introduced in version 1.3b89

Retrieves the token's image width in pixels (boundary size).

getTokenWidth()
getTokenWidth(tokenRef)
getTokenWidth(tokenRef, mapRef)

Parameters

tokenRef - Either the token id 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.
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.

Assuming a token called "Dragon", medium size, on a 50px square grid, then:

[r: getTokenWidth("Dragon")]

returns:

@@ Line 10: / Line 10: @@
 <syntaxhighlight lang="mtmacro" line>
 getTokenWidth()
-getTokenWidth(id)
+getTokenWidth(tokenRef)
-getTokenWidth(id, mapname)
+getTokenWidth(tokenRef, mapRef)
 </syntaxhighlight>
 '''Parameters'''
-{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}}
+{{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|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 />