setPenWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=setPenWidth |version=1.4.1.9 |trusted=true |description= Sets the line width for a specified drawing. Regardless of the set width, a line will only be vi...")
 
No edit summary
Line 8: Line 8:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setPenWidth(mapName, drawingId, paint)
setPenWidth(mapName, drawingId, width)
</source>
</source>
'''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.}}
{{param|paint|A string representing the colour or texture of the pen.}}
{{param|width|A number for the desired line thickness.}}
|examples=
|examples=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h:setPenWidth("Grasslands", "0000000094218C675800000000000000",10)]
[h:setPenWidth("Grasslands", "0000000094218C675800000000000000",10)]
[h:setPenWidth("Grasslands", "0000000087318B505800000000000000",120)]
[h:setPenWidth("Grasslands", "0000000087318B505800000000000000",3)]
</source>
</source>
|also=
|also=

Revision as of 10:41, 9 February 2018

setPenWidth() Function

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

Introduced in version 1.4.1.9
Sets the line width for a specified drawing. Regardless of the set width, a line will only be visible if it has a visible colour. See setPenColor.

Usage

setPenWidth(mapName, drawingId, width)

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.
  • width - A number for the desired line thickness.

Examples

[h:setPenWidth("Grasslands", "0000000094218C675800000000000000",10)]
[h:setPenWidth("Grasslands", "0000000087318B505800000000000000",3)]

See Also