isSnapToGrid: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 32: Line 32:
|also=
|also=
{{func|setTokenSnapToGrid}}
{{func|setTokenSnapToGrid}}
}}


|changes=
|changes=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 16:41, 29 August 2024

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

Version Changes

  • 1.5.4 - Added mapname parameter option.