resetSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
resetSize() | resetSize() | ||
resetSize(id) | resetSize(id) | ||
resetSize(id, mapname) | resetSize(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The token {{code|id}} of the token to reset, defaults to the [[Current Token]].}} | {{param|id|The token {{code|id}} of the token to reset, defaults to the [[Current Token]].}} | ||
| Line 18: | Line 18: | ||
|examples= | |examples= | ||
To reset the size of the current token to the default for the map: | To reset the size of the current token to the default for the map: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: resetSize()] | [h: resetSize()] | ||
</ | </syntaxhighlight> | ||
To reset the size of token '''Chocolate Moose''' on map '''Cadbury''': | To reset the size of token '''Chocolate Moose''' on map '''Cadbury''': | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: tok = "Chocolate Moose"] | [h: tok = "Chocolate Moose"] | ||
[h: map = "Cadbury"] | [h: map = "Cadbury"] | ||
[h: resetSize(tok, map)] | [h: resetSize(tok, map)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 22:10, 14 March 2023
resetSize() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.
Usage
resetSize()
resetSize(id)
resetSize(id, mapname)Parameters
id- The tokenidof the token to reset, defaults to the Current Token.mapName- Optional map name to find the token. Defaults to current map.
Examples
To reset the size of the current token to the default for the map:
[h: resetSize()]To reset the size of token Chocolate Moose on map Cadbury:
[h: tok = "Chocolate Moose"]
[h: map = "Cadbury"]
[h: resetSize(tok, map)]See Also
Version Changes
- 1.5.4 - Added
mapNameparameter option.