setTokenSnapToGrid: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
setTokenSnapToGrid(snap) | setTokenSnapToGrid(snap) | ||
setTokenSnapToGrid(snap, id) | setTokenSnapToGrid(snap, id) | ||
setTokenSnapToGrid(snap, id, mapname) | |||
</source> | </source> | ||
| Line 14: | Line 15: | ||
{{param|snap|A value {{true}} or {{false}}.}} | {{param|snap|A value {{true}} or {{false}}.}} | ||
{{param|id|The id of the token to set its snap behaviour.}} | {{param|id|The id of the token to set its snap behaviour.}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
| Line 19: | Line 22: | ||
[h: setTokenSnapToGrid(0)] | [h: setTokenSnapToGrid(0)] | ||
[h: setTokenSnapToGrid(1, currentToken())]</source> | [h: setTokenSnapToGrid(1, currentToken())]</source> | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
{{func|isSnapToGrid}} | {{func|isSnapToGrid}} | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 21:03, 15 August 2019
setTokenSnapToGrid() Function
• Introduced in version 1.4
Sets the "snap to" behaviour for the Current Token or a specified token.
Usage
setTokenSnapToGrid(snap)
setTokenSnapToGrid(snap, id)
setTokenSnapToGrid(snap, id, mapname)Parameters
snap- A valuetrue(1) orfalse(0).id- The id of the token to set its snap behaviour.mapname- The name of the map to find the token. Defaults to the current map.
Example
[h: setTokenSnapToGrid(0)]
[h: setTokenSnapToGrid(1, currentToken())]See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.