sendDrawingToBack: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
|trusted=true
|trusted=true
|description=
|description=
For a specified drawing, moves the drawing to behind of all other drawings on the same layer.
Moves the specified drawing to be behind of all other drawings on the same layer.
 
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
sendDrawingToBack(mapName, drawingId)
sendDrawingToBack(mapName, drawingId)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{param|mapName|A string containing the name 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 drawing ids is via the '''Draw Explorer''' interface.}}
 
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:sendDrawingToBack("Grasslands", "0000000074836E675D00000000000000")]
[r:sendDrawingToBack("Grasslands", "0000000074836E675D00000000000000")]
</source>
</syntaxhighlight>
 
|also=
|also=
{{func|bringDrawingToFront}}
{{func|bringDrawingToFront}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Latest revision as of 21:11, 14 March 2023

sendDrawingToBack() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.4.1.7
Moves the specified drawing to be behind of all other drawings on the same layer.

Usage

sendDrawingToBack(mapName, drawingId)

Parameters

  • mapName - A string containing the name of the map.
  • drawingId - A string containing the id of the drawing. The easiest way to discover drawing ids is via the Draw Explorer interface.

Examples

[r:sendDrawingToBack("Grasslands", "0000000074836E675D00000000000000")]

See Also