resetSize

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(tokenRef)
resetSize(tokenRef, mapRef)

Parameters

• tokenRef - Either the token id or Token Name of the token to reset, defaults to the Current Token.
• mapRef - Optional. Name or ID of the map to find the token. Defaults to current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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

getSize() setSize()

Version Changes

• 1.5.4 - Added mapName parameter option.