getDrawingLayer: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getDrawingLayer to GetDrawingLayer without leaving a redirect: Converting page title to first-letter uppercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 6: | Line 6: | ||
For a specified drawing, returns the layer to which the drawing belongs. | For a specified drawing, returns the layer to which the drawing belongs. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getDrawingLayer( | getDrawingLayer(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:getDrawingLayer("Grasslands", "0000000074836E675D00000000000000")] | [r:getDrawingLayer("Grasslands", "0000000074836E675D00000000000000")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setDrawingLayer}} | {{func|setDrawingLayer}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] |
Latest revision as of 23:59, 14 March 2023
getDrawingLayer() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
For a specified drawing, returns the layer to which the drawing belongs.
Usage
getDrawingLayer(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:getDrawingLayer("Grasslands", "0000000074836E675D00000000000000")]