resetSize: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 23: Line 23:


To reset the size of token '''Chocolate Moose''' on map '''Cadbury''':
To reset the size of token '''Chocolate Moose''' on map '''Cadbury''':
<soursyntaxhighlight ce lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: tok = "Chocolate Moose"]
[h: tok = "Chocolate Moose"]
[h: map = "Cadbury"]
[h: map = "Cadbury"]

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 token id of 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 mapName parameter option.