setDrawingLayer: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
{{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.}}
|examples=
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r:setDrawingLayer("Grasslands", "0000000074836E675D00000000000000","GM")]
[r:setDrawingLayer("Grasslands", "0000000074836E675D00000000000000","GM")]
[refreshDrawing("Grasslands", "0000000074836E675D00000000000000")]
</source>
</source>
|also=
|also=
{{func|getDrawingLayer}}
{{func|getDrawingLayer}} {{func|refreshDrawing}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Revision as of 20:50, 5 February 2018

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(mapName, drawingId, layer)

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.
  • layer - The layer to move the drawing to.

Example

[r:setDrawingLayer("Grasslands", "0000000074836E675D00000000000000","GM")]
[refreshDrawing("Grasslands", "0000000074836E675D00000000000000")]

See Also