isSnapToGrid: Difference between revisions

Latest revision as of 20:13, 15 March 2023

• Introduced in version 1.3b69

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

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.

[h: snap=isSnapToGrid()]

@@ Line 1: / Line 1: @@
-{{stub|Examples}}
 {{MacroFunction
@@ Line 16: / Line 14: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 isSnapToGrid()
-</source>
-<source lang="mtmacro" line>
 isSnapToGrid(id)
+isSnapToGrid(id, mapname)
-</source>
+</syntaxhighlight>
 '''Parameter'''
 {{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.}}
+|example=
+<syntaxhighlight lang="mtmacro" line>
+[h: snap=isSnapToGrid()]</syntaxhighlight>
+|also=
+{{func|setTokenSnapToGrid}}
 }}
+|changes=
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 [[Category:Token Function]]