setDrawingEraser: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:
{{param|drawingId|A string containing the id of the drawing. The easiest way to discover a drawing's Id is via the Draw Explorer interface.}}
{{param|drawingId|A string containing the id of the drawing. The easiest way to discover a drawing's Id is via the Draw Explorer interface.}}
{{param|boolean|The value of the setting to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}}
{{param|boolean|The value of the setting to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}}
|examples=
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r:setDrawingEraser("Grasslands", "0000000094218C675800000000000000",0)]
[r:setDrawingEraser("Grasslands", "0000000094218C675800000000000000",0)]

Revision as of 20:49, 5 February 2018

setDrawingEraser() 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

setDrawingEraser(mapName, drawingId, paint)

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

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

See Also