isSnapToGrid

isSnapToGrid() Function

• Introduced in version 1.3b69

Returns true(1) if a Token is snapped to grid or false(0) if it is not.

Usage

isSnapToGrid()
isSnapToGrid(tokenRef)
isSnapToGrid(tokenRef, mapname)

Parameter

• tokenRef - Either the token id or Token Name of the token which has its snapToGrid status checked, defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

• mapname - The name of the map to find the token. Defaults to the 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.

Example

[h: snap=isSnapToGrid()]

See Also

setTokenSnapToGrid()

Version Changes

• 1.5.4 - Added mapname parameter option.