getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Tweaking page layout and typography. Not a stub anymore.)
mNo edit summary
Line 5: Line 5:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's image width in pixels (boundary size).
Retrieves the token's image width in pixels (boundary size).


|usage=
|usage=
Line 14: Line 14:


'''Parameters'''
'''Parameters'''
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}}


'''Result'''<br />
'''Result'''<br />

Revision as of 21:45, 6 March 2019

getTokenWidth() Function

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

Usage

getTokenWidth()
getTokenWidth(id)

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

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