getPenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:
A drawing will have a line width, even if the line itself is not displayed. See setPenColor.
A drawing will have a line width, even if the line itself is not displayed. See setPenColor.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getPenWidth(mapName, drawingId)
getPenWidth(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 a drawing's Id is via the Draw Explorer interface.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getPenWidth("Grasslands", "0000000074836E675D00000000000000")]
[r:getPenWidth("Grasslands", "0000000074836E675D00000000000000")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setPenWidth}} {{func|setPenColor}}
{{func|setPenWidth}} {{func|setPenColor}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Latest revision as of 19:36, 14 March 2023

getPenWidth() Function

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

Introduced in version 1.5.0
Returns the line width for the specified drawing. A drawing will have a line width, even if the line itself is not displayed. See setPenColor.

Usage

getPenWidth(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 a drawing's Id is via the Draw Explorer interface.

Examples

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

See Also