setTokenSnapToGrid

setTokenSnapToGrid() Function

• Introduced in version 1.4

Sets the "snap to" behaviour for the Current Token or a specified token.

Usage

setTokenSnapToGrid(snap)
setTokenSnapToGrid(snap, id)
setTokenSnapToGrid(snap, id, mapRef)

Parameters

• snap - A value true(1) or false(0).
• id - The id of the token to set its snap behaviour.
• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Example

[h: setTokenSnapToGrid(0)]
[h: setTokenSnapToGrid(1, currentToken())]

See Also

isSnapToGrid()

Version Changes

• 1.5.4 - Added mapname parameter option.