getTokenWidth

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

getTokenHeight()

getTokenNativeHeight()

getTokenNativeWidth()

Version Changes

• 1.5.4 - Added mapname parameter option.