setDrawingLayer: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetDrawingLayer to setDrawingLayer: Converting page titles to lowercase)
No edit summary
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

Revision as of 08:35, 12 February 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(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

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

See Also