getDrawingEraser: Difference between revisions
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...") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getDrawingEraser | |name=getDrawingEraser | ||
|version=1. | |version=1.5.0 | ||
|trusted=true | |trusted=true | ||
|description= | |description= | ||
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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getDrawingEraser( | getDrawingEraser(mapRef, drawingId) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|mapRef|The Name or ID of the map.}} | ||
{{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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")] | [r:getDrawingEraser("Grasslands", "0000000074836E675D00000000000000")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setDrawingEraser}} | {{func|setDrawingEraser}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 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(mapRef, drawingId)Parameters
mapRef- The Name or ID 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")]