getDrawingEraser: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(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...")
 
mNo edit summary
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getDrawingEraser
|name=getDrawingEraser
|version=1.4.1.9
|version=1.5.0
|trusted=true
|trusted=true
|description=
|description=

Revision as of 16:43, 13 February 2019

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

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