getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Tweaking page layout and typography. Not a stub anymore.)
Line 1: Line 1:
{{stub|Lacks examples}}
{{MacroFunction
{{MacroFunction
|name=getTokenWidth
|name=getTokenWidth
Line 20: Line 19:
The token's boundary (image) width in pixels.
The token's boundary (image) width in pixels.
|example=
|example=
Assuming a token called "Dragon", medium size, on a 50px square grid, then
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r: getTokenWidth("Dragon")]
[r: getTokenWidth("Dragon")]

Revision as of 15:09, 10 April 2013

getTokenWidth() Function

Introduced in version 1.3b89
This function 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.

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