setDrawingLayer: Difference between revisions

From RPTools Wiki
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
Line 24: Line 24:
</source>
</source>
|also=
|also=
{}}}
{{func|getDrawingLayer}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Revision as of 19:52, 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.

Examples

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

See Also