getTokenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Modified usage)
m (Text replacement - "source>" to "syntaxhighlight>")
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{stub|Lacks a proper description.<br />
Lacks examples}}
{{MacroFunction
{{MacroFunction
|name=getTokenWidth
|name=getTokenWidth
Line 7: Line 5:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's width.
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(id)
</source>
getTokenWidth(id, mapname)
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|The token id of the token to check for its width, defaults to the [[Current Token]].}}{{TrustedParameter}}
{{param|id|The token id 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.}}


'''Result'''<br />
'''Result'''<br />
The token's 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]]

Revision as of 21:05, 14 March 2023

getTokenWidth() Function

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

Usage

getTokenWidth()
getTokenWidth(id)
getTokenWidth(id, mapname)

Parameters

  • id - The token id 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.


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.