setDrawingEraser

From RPTools Wiki
Jump to navigationJump to search

setDrawingEraser() Function

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

Introduced in version 1.5.0
Sets the eraser setting of the drawing that corresponds to the map and drawing id. If Set to false(0) the drawing will be displayed normally, but if set to true(1) the drawing will erase all below.

Usage

setDrawingEraser(mapName, drawingId, boolean)

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.
  • boolean - The value of the setting to set, true(1) or false(0).

Example

[h:setDrawingEraser("Grasslands", "0000000094218C675800000000000000",0)]
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")]
[h:setDrawingEraser("Grasslands", "00000000CCF6B567CC00000000000000",1)]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]

See Also