getTokenHeight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created empty)
 
(Adding description, usage, link to other functions)
Line 1: Line 1:
{{stub|Empty article at the moment.}}
{{stub|Lacks a proper description.<br />
What does the result look like?<br />
Lacks examples.}}
{{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.
This function retrieves the token's height.


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


'''Parameter'''
{{param|id|The token id of the token to check for its height, defaults to the [[Current Token]].}}{{TrustedParameter}}
'''Result'''
{{note|???}}
|example=
|example=
This example doesn't really do anything.
This example doesn't really do anything.
Line 25: Line 32:


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

Revision as of 13:24, 8 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 a proper description.
What does the result look like?
Lacks examples.

getTokenHeight() Function

Introduced in version 1.3b89
This function retrieves the token's height.

Usage

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

???

Example

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

Returns:

c,b,a

See Also