isSnapToGrid: Difference between revisions

Latest revision as of 15:53, 17 May 2024

• Introduced in version 1.3b69

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

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.

[h: snap=isSnapToGrid()]

@@ Line 1: / Line 1: @@
-{{stub|Examples}}
 {{MacroFunction
@@ Line 16: / Line 14: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 isSnapToGrid()
+isSnapToGrid(tokenRef)
+isSnapToGrid(tokenRef, mapname)
+</syntaxhighlight>
-</source>
+'''Parameter'''
-<source lang="mtmacro" line>
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}}
+{{Note|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.}}
-isSnapToGrid(id)
+|example=
+<syntaxhighlight lang="mtmacro" line>
+[h: snap=isSnapToGrid()]</syntaxhighlight>
-</source>
+|also=
+{{func|setTokenSnapToGrid}}
-'''Parameter'''
+}}
-{{param|id|The token {{code|id}} of the token which has its snapToGrid status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
-}}
+|changes=
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 [[Category:Token Function]]