movedOverDrawing: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page MovedOverDrawing to movedOverDrawing: Converting page titles to lowercase) |
No edit summary |
||
| Line 8: | Line 8: | ||
Returns a JSON array with coordinates of all cells in the path that overlap with the area defined by the given drawing. | Returns a JSON array with coordinates of all cells in the path that overlap with the area defined by the given drawing. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
movedOverDrawing(mapName, drawingId, path) | movedOverDrawing(mapName, drawingId, path) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|mapName|A string containing the name of the map.}} | {{param|mapName|A string containing the name of the map.}} | ||
| Line 16: | Line 16: | ||
{{param|path|JSON array of X/Y coordinate such as that returned by {{func|getLastPath}}}} | {{param|path|JSON array of X/Y coordinate such as that returned by {{func|getLastPath}}}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: lp = getLastPath()] | [h: lp = getLastPath()] | ||
[h: id = findDrawings(getCurrentMapName(),"fig1")] | [h: id = findDrawings(getCurrentMapName(),"fig1")] | ||
[r: movedOverDrawing(getCurrentMapName(),id,lp)] | [r: movedOverDrawing(getCurrentMapName(),id,lp)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 23:07, 14 March 2023
movedOverDrawing() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.2
Use to check if a given path has crossed through a specified drawing including templates. The easiest way to discover a drawing's Id is via the Draw Explorer interface.
Returns a JSON array with coordinates of all cells in the path that overlap with the area defined by the given drawing.
Usage
movedOverDrawing(mapName, drawingId, path)Parameters
mapName- A string containing the name of the map.drawingId- A string containing the id of the drawing.path- JSON array of X/Y coordinate such as that returned by getLastPath()
Examples
[h: lp = getLastPath()]
[h: id = findDrawings(getCurrentMapName(),"fig1")]
[r: movedOverDrawing(getCurrentMapName(),id,lp)]