getDrawingOpacity: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page getDrawingOpacity to GetDrawingOpacity without leaving a redirect: Converting page title to first-letter uppercase)
m (Text replacement - "source>" to "syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 6: Line 6:
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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getDrawingOpacity(mapName, drawingId)
getDrawingOpacity(mapRef, drawingId)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getDrawingOpacity("Grasslands", "0000000094218C675800000000000000")]
[r:getDrawingOpacity("Grasslands", "0000000094218C675800000000000000")]
</source>
</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")]

See Also