getPenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetPenWidth to getPenWidth: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 9: Line 9:
<source lang="mtmacro" line>
<source 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.}}
Line 16: Line 16:
<source lang="mtmacro" line>
<source 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]]

Revision as of 18:52, 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

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

<source lang="mtmacro" line>

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

</syntaxhighlight>

See Also