getTokenWidth

getTokenWidth() Function

• Introduced in version 1.3b89

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

Usage

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.

Example

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

[r: getTokenWidth("Dragon")]

returns:

50

See Also

getTokenHeight()

getTokenNativeHeight()

getTokenNativeWidth()

Version Changes

• 1.5.4 - Added mapname parameter option.