isSnapToGrid: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:


<source lang="mtmacro" line>
<source lang="mtmacro" line>
isSnapToGrid()
isSnapToGrid()
</source>
<source lang="mtmacro" line>
isSnapToGrid(id)
isSnapToGrid(id)
 
isSnapToGrid(id, mapname)
</source>
</source>


Line 29: Line 23:


{{param|id|The token {{code|id}} of the token which has its snapToGrid status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token which has its snapToGrid status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
 
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}




Line 39: Line 33:
{{func|setTokenSnapToGrid}}
{{func|setTokenSnapToGrid}}
}}
}}
|changes=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


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

Revision as of 20:48, 15 August 2019

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(id)
isSnapToGrid(id, mapname)

Parameter

  • id - The token id 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.

Example

[h: snap=isSnapToGrid()]

See Also


|changes=

  • 1.5.4 - Added mapname parameter option.