getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Modified usage)
(More explicit description and usage)
Line 1: Line 1:
{{stub|Lacks a proper description.<br />
{{stub|Lacks examples.}}
Lacks examples.}}
{{MacroFunction
{{MacroFunction
|name=getTokenHeight
|name=getTokenHeight
Line 7: Line 6:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's height.
This function retrieves the token's image height (boundary size).


|usage=
|usage=
Line 19: Line 18:


'''Result'''<br />
'''Result'''<br />
The token's height in pixels.
The token's boundary (image) height in pixels.
|example=
|example=
This example doesn't really do anything.
This example doesn't really do anything.

Revision as of 10:50, 9 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.

getTokenHeight() Function

Introduced in version 1.3b89
This function retrieves the token's image height (boundary size).

Usage

getTokenHeight()
getTokenHeight(id)

Parameter

  • id - The token id of the token to check for its height, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

Result
The token's boundary (image) height in pixels.

Example

This example doesn't really do anything.
[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]

Returns:

c,b,a

See Also