getDrawingEraser

From RPTools Wiki
Revision as of 20:43, 5 February 2018 by Jagged (talk | contribs) (Created page with "{{MacroFunction |name=getDrawingEraser |version=1.4.1.9 |trusted=true |description= Returns a value corresponding to the eraser setting of the drawing. A normal visible drawin...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

getDrawingEraser() Function

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

Introduced in version 1.4.1.9
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

getDrawingEraser(mapName, drawingId)

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

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

See Also