setDrawingLayer: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=setDrawingLayer |version=1.4.1.7 |trusted=true |description= For a specified drawing, set the layer of the map to which the drawing belongs. The Map L...") |
No edit summary |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
For a specified drawing, set the layer of the map to which the drawing belongs. | For a specified drawing, set the layer of the map to which the drawing belongs. | ||
The [[Map Layer]] is one of: | The [[Introduction to Mapping#introduction to Mapping|Map Layer]] is one of: | ||
* {{code|TOKEN}} | * {{code|TOKEN}} | ||
* {{code|GM}} also known as Hidden | * {{code|GM}} also known as Hidden | ||
* {{code|OBJECT}} | * {{code|OBJECT}} | ||
* {{code|BACKGROUND}} | * {{code|BACKGROUND}} | ||
| |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setDrawingLayer( | setDrawingLayer(mapRef, drawingId, layer) | ||
</ | </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.}} | ||
{{param|layer|The layer to move the drawing to.}} | {{param|layer|The layer to move the drawing to.}} | ||
| | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[ | [h:setDrawingLayer("Grasslands", "0000000074836E675D00000000000000","GM")] | ||
</ | [h:refreshDrawing("Grasslands", "0000000074836E675D00000000000000")] | ||
</syntaxhighlight> | |||
|also= | |also= | ||
{}}} | {{func|getDrawingLayer}} {{func|refreshDrawing}} | ||
}} | |||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 14 March 2023
setDrawingLayer() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.4.1.7
For a specified drawing, set the layer of the map to which the drawing belongs.
The Map Layer is one of:
TOKENGMalso known as HiddenOBJECTBACKGROUND
Usage
setDrawingLayer(mapRef, drawingId, layer)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.layer- The layer to move the drawing to.
Example
[h:setDrawingLayer("Grasslands", "0000000074836E675D00000000000000","GM")]
[h:refreshDrawing("Grasslands", "0000000074836E675D00000000000000")]