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