getTokenNativeWidth

getTokenWidth() Function

• Introduced in version 1.5.1

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

Usage

getTokenNativeWidth()
getTokenNativeWidth(tokenRef)
getTokenNativeWidth(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 native (image) width in pixels.

Example

Assuming a token called "Dragon", with 120px native image width, medium size, on a 50px square grid , then:

[r: getTokenWidth("Dragon")]

returns:

120

See Also

getTokenWidth()

getTokenHeight()

getTokenNativeHeight()

Version Changes

• 1.5.4 - Added mapname parameter option.