setDrawingOpacity: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=setDrawingOpacity | |name=setDrawingOpacity | ||
|version=1. | |version=1.5.0 | ||
|trusted=true | |trusted=true | ||
|description= | |description= | ||
Sets the transparency value of a specified drawing. | Sets the transparency value of a specified drawing. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setDrawingOpacity( | setDrawingOpacity(mapRef, drawingId, opacity) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{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|opacity|A number between 1 and 0 representing the transparency of the drawing.}} | {{param|opacity|A number between 1 and 0 representing the transparency of the drawing.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:setDrawingOpacity("Grasslands", "0000000094218C675800000000000000",0.5)] | [h:setDrawingOpacity("Grasslands", "0000000094218C675800000000000000",0.5)] | ||
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")] | [h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getDrawingOpacity}} {{func|refreshDrawing}} | {{func|getDrawingOpacity}} {{func|refreshDrawing}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 14 March 2023
setDrawingOpacity() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Sets the transparency value of a specified drawing.
Usage
setDrawingOpacity(mapRef, drawingId, opacity)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.opacity- A number between 1 and 0 representing the transparency of the drawing.
Examples
[h:setDrawingOpacity("Grasslands", "0000000094218C675800000000000000",0.5)]
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")]