setDrawingLayer: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 15: Line 15:
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setDrawingLayer(mapName, drawingId, layer)
setDrawingLayer(mapRef, drawingId, layer)
</syntaxhighlight>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{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.}}

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:

  • TOKEN
  • GM also known as Hidden
  • OBJECT
  • BACKGROUND
 

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")]

See Also