isSnapToGrid: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 17: Line 17:
isSnapToGrid()
isSnapToGrid()
isSnapToGrid(tokenRef)
isSnapToGrid(tokenRef)
isSnapToGrid(tokenRef, mapname)
isSnapToGrid(tokenRef, mapRef)
</syntaxhighlight>
</syntaxhighlight>


Line 23: Line 23:


{{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|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.}}
{{param|mapRef|The Name or ID 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.}}
{{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.}}



Latest revision as of 23:59, 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, mapRef)

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

  • mapRef - The Name or ID 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.