getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{stub|Lacks examples}}
{{MacroFunction
{{MacroFunction
|name=getTokenWidth
|name=getTokenWidth
Line 6: Line 5:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's image width (boundary size).
Retrieves the token's image width in pixels (boundary size).


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenWidth()
getTokenWidth()
getTokenWidth(id)
getTokenWidth(tokenRef)
</source>
getTokenWidth(tokenRef, mapname)
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}}
{{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 />
'''Result'''<br />
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 {{code|"Dragon"}}, medium size, on a 50px square grid, then:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[r: getTokenWidth("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=
{{func|getTokenHeight}}
{{func|getTokenHeight}}
{{func|getTokenNativeHeight}}
{{func|getTokenNativeWidth}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 16:38, 14 May 2024

getTokenWidth() Function

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

Usage

getTokenWidth()
getTokenWidth(tokenRef)
getTokenWidth(tokenRef, mapname)

Parameters

  • tokenRef - Either the token id or Token Name of the token to check for its width, defaults to the Current Token.

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

  • 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) width in pixels.

Example

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

returns:

50

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.