resetSize

From RPTools Wiki
Revision as of 13:05, 13 August 2019 by Phergus (talk | contribs) (Created page with "{{MacroFunction |name=setSize |trusted=true |version=1.3b48 |description= Resets the Size of a Token to the default for grid type of the map it occupies. See {{func|s...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

setSize() 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.