getDrawingEraser: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 6: Line 6:
Returns a value corresponding to the eraser setting of the drawing. A normal visible drawing will return {{code|false}}({{code|0}}), while a drawing that cuts the drawing below it will return {{code|true}}({{code|1}}).
Returns a value corresponding to the eraser setting of the drawing. A normal visible drawing will return {{code|false}}({{code|0}}), while a drawing that cuts the drawing below it will return {{code|true}}({{code|1}}).
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getDrawingEraser(mapName, drawingId)
getDrawingEraser(mapName, drawingId)
</syntaxhighlight>
</syntaxhighlight>
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.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")]
[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")]
</syntaxhighlight>
</syntaxhighlight>

Revision as of 17:46, 14 March 2023

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