getDrawingOpacity: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetDrawingOpacity to getDrawingOpacity: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
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(mapName, drawingId)
</source>
</source>
Line 13: Line 13:
{{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>
</source>

Revision as of 17:44, 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

<syntaxhighlight lang="mtmacro" line> getDrawingOpacity(mapName, drawingId) </source> 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.

Examples

<syntaxhighlight lang="mtmacro" line>

[r:getDrawingOpacity("Grasslands", "0000000094218C675800000000000000")]

</source>

See Also