getTokenNativeWidth

From RPTools Wiki
Revision as of 23:35, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page GetTokenNativeWidth to getTokenNativeWidth: Converting page titles to lowercase)
Jump to navigation Jump to search

getTokenWidth() Function

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

Usage

getTokenNativeWidth()
getTokenNativeWidth(id)
getTokenNativeWidth(id, mapname)

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 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

Version Changes

  • 1.5.4 - Added mapname parameter option.