setPenWidth: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page setPenWidth to SetPenWidth without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
Regardless of the set width, a line will only be visible if it has a visible colour. See setPenColor. | Regardless of the set width, a line will only be visible if it has a visible colour. See setPenColor. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setPenWidth( | setPenWidth(mapRef, drawingId, width) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|mapRef|The Name or ID 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|width|A number for the desired line thickness.}} | {{param|width|A number for the desired line thickness.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:setPenWidth("Grasslands", "0000000094218C675800000000000000",10)] | [h:setPenWidth("Grasslands", "0000000094218C675800000000000000",10)] | ||
[h:setPenWidth("Grasslands", "0000000087318B505800000000000000",3)] | [h:setPenWidth("Grasslands", "0000000087318B505800000000000000",3)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getPenWidth}} {{func|setPenColor}} | {{func|getPenWidth}} {{func|setPenColor}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 14 March 2023
setPenWidth() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
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(mapRef, drawingId, width)Parameters
mapRef- The Name or ID 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)]