getPenWidth

From RPTools Wiki
Revision as of 18:52, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

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