setPenColor: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=setPenColor |version=1.4.1.9 |trusted=true |description= Sets the colour or texture of the pen for a specified drawing. |usage= <source lang="mtmacro" li...") |
No edit summary |
||
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=setPenColor | |name=setPenColor | ||
|version=1. | |version=1.5.0 | ||
|trusted=true | |trusted=true | ||
|description= | |description= | ||
Sets the colour or texture of the pen for a specified drawing. | Sets the colour or texture of the pen for a specified drawing. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setPenColor( | setPenColor(mapRef, drawingId, paint) | ||
</ | </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|paint|A string representing the .}} | {{param|paint|A string representing the colour or texture of the pen.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","red")] | [r:setPenColor("Grasslands", "0000000094218C675800000000000000","red")] | ||
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","#ff0000")] | [r:setPenColor("Grasslands", "0000000094218C675800000000000000","#ff0000")] | ||
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","asset://ffff0fe019c241c7456b0ec0b347ef37")] | [r:setPenColor("Grasslands", "0000000094218C675800000000000000","asset://ffff0fe019c241c7456b0ec0b347ef37")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getPenColor}} | {{func|getPenColor}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] |
Latest revision as of 23:59, 14 March 2023
setPenColor() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Sets the colour or texture of the pen for a specified drawing.
Usage
setPenColor(mapRef, drawingId, paint)
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.paint
- A string representing the colour or texture of the pen.
Examples
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","red")]
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","#ff0000")]
[r:setPenColor("Grasslands", "0000000094218C675800000000000000","asset://ffff0fe019c241c7456b0ec0b347ef37")]