getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's image width (boundary size).
This function retrieves the token's image width in pixels (boundary size).


|usage=
|usage=
Line 20: Line 20:
The token's boundary (image) width in pixels.
The token's boundary (image) width in pixels.
|example=
|example=
This example doesn't really do anything.
Assuming a token called "Dragon", medium size, on a 50px square grid, then
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[r: getTokenWidth("Dragon")]
[r: exampleFunction(exampleVariable, reverse)]
</source>
</source>
Returns:
returns:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
c,b,a
50
</source>
</source>



Revision as of 12:03, 10 April 2013

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Lacks examples

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