setTokenWidth: Difference between revisions

Latest revision as of 23:59, 14 March 2023

• Introduced in version 1.3b91

Sets the token's image width in pixels (boundary size).

setTokenWidth(size)
setTokenWidth(size, id)
setTokenWidth(size, id, mapRef)

Parameters

size - grid size of the token
id - The token id of the token to set its width. Defaults to the Current Token.
Note: This parameter can only be used in a Trusted Macro.
mapRef - The Name or ID of the map to find the token. Defaults to the current map.

[r: setTokenWidth(300, "Dragon")]
[r: setTokenHeight(150, "Dragon")]

@@ Line 5: / Line 5: @@
 |version=1.3b91
 |description=
-This function set the token's image width in pixels (boundary size).
+Sets the token's image width in pixels (boundary size).
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
+setTokenWidth(size)
 setTokenWidth(size, id)
-</source>
+setTokenWidth(size, id, mapRef)
+</syntaxhighlight>
 '''Parameters'''
 {{param|size|grid size of the token}}
-{{param|id|The token id of the token to set its width}}
+{{param|id|The token {{code|id}} of the token to set its width.  Defaults to the [[Current_Token|Current Token]].}}{{TrustedParameter}}
+{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
 |example=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [r: setTokenWidth(300, "Dragon")]
 [r: setTokenHeight(150, "Dragon")]
-</source>
+</syntaxhighlight>
+|changes=
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 |also=
-{{func|setTokenHeight}},
+{{func|setTokenHeight}}, {{func|getTokenHeight}}, {{func|getTokenWidth}}
-{{func|getTokenHeight}},
-{{func|getTokenWidth}}
 }}
 [[Category:Token Function]]