getDrawingEraser: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetDrawingEraser to getDrawingEraser: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 8: | Line 8: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getDrawingEraser(mapName, drawingId) | getDrawingEraser(mapName, drawingId) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|mapName|A string containing the name of the map.}} | {{param|mapName|A string containing the name of the map.}} | ||
| Line 15: | Line 15: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")] | [r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setDrawingEraser}} | {{func|setDrawingEraser}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Revision as of 17:39, 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
<source lang="mtmacro" line> getDrawingEraser(mapName, drawingId) </syntaxhighlight> 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
<source lang="mtmacro" line>
[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")]
</syntaxhighlight>