movedOverDrawing

From RPTools Wiki
Jump to navigationJump to search

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

getDrawingInfo(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)]

See Also