setPenColor: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=setPenColor
|name=setPenColor
|version=1.4.1.9
|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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setPenColor(mapName, drawingId, paint)
setPenColor(mapRef, drawingId, paint)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{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 colour or texture of the pen.}}
{{param|paint|A string representing the colour or texture of the pen.}}
|examples=
|examples=
<source lang="mtmacro" line>
<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")]
</source>
</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")]

See Also