getDrawingEraser

From RPTools Wiki
Revision as of 17:39, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

getDrawingEraser() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.0
Returns a value corresponding to the eraser setting of the drawing. A normal visible drawing will return false(0), while a drawing that cuts the drawing below it will return true(1).

Usage

<source lang="mtmacro" line> getDrawingEraser(mapName, drawingId) </syntaxhighlight> Parameters

  • mapName - A string containing the name of the map.
  • drawingId - A string containing the id of the drawing. The easiest way to discover a drawing's Id is via the Draw Explorer interface.

Examples

<source lang="mtmacro" line>

[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")]

</syntaxhighlight>

See Also