getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page getTokenWidth to GetTokenWidth without leaving a redirect: Converting page title to first-letter uppercase)
m (Conversion script moved page GetTokenWidth to getTokenWidth: Converting page titles to lowercase)
(No difference)

Revision as of 23:31, 9 February 2023

getTokenWidth() Function

Introduced in version 1.3b89
Retrieves the token's image width in pixels (boundary size).

Usage

getTokenWidth()
getTokenWidth(id)
getTokenWidth(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 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

Version Changes

  • 1.5.4 - Added mapname parameter option.