getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created empty)
 
No edit summary
 
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{stub|Empty article at the moment.}}
{{MacroFunction
{{MacroFunction
|name=getTokenHeight
|name=getTokenHeight
|proposed=false
|proposed=false
|trusted=true
|trusted=false
|version=1.3b89
|version=1.3b89
|description=
|description=
This is an example function.  It doesn't actually exist as a function in MapTool.
Retrieves the token's image height in pixels (boundary size).


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
exampleFunction(param1, param2)
getTokenHeight()
</source>
getTokenHeight(tokenRef)
getTokenHeight(tokenRef, mapname)
</syntaxhighlight>


'''Parameter'''
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for its height, defaults to the [[Current Token]].}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
'''Result'''<br />
The token's boundary (image) height in pixels.
|example=
|example=
This example doesn't really do anything.
Assuming a token called {{code|"Dragon"}}, medium size, on a 50px square grid, then:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[r: getTokenHeight("Dragon")]
[r: exampleFunction(exampleVariable, reverse)]
</syntaxhighlight>
</source>
returns:
Returns:
<syntaxhighlight lang="mtmacro" line>
<source lang="mtmacro" line>
50
c,b,a
</syntaxhighlight>
</source>
 
|changes=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


|also=
|also=
[[linkToRelatedArticle|Display Name of Related Article]]
{{func|getTokenNativeHeight}}
{{func|getTokenWidth}}
{{func|getTokenNativeWidth}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 16:21, 14 May 2024

getTokenHeight() Function

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

Usage

getTokenHeight()
getTokenHeight(tokenRef)
getTokenHeight(tokenRef, mapname)

Parameter

  • tokenRef - Either the token id or Token Name of the token to check for its height, defaults to the Current Token.
  • mapname - The name of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


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

Example

Assuming a token called "Dragon", medium size, on a 50px square grid, then:
[r: getTokenHeight("Dragon")]

returns:

50

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.