setLineCap: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetLineCap to setLineCap: Converting page titles to lowercase)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
Sets the line cap setting of the drawing that corresponds to the map and drawing id. If Set to {{code|round}}({{code|0}}) the drawing will display with round line ends, but if set to {{code|square}}({{code|1}}) the drawing display with square line ends and angled corners.
Sets the line cap setting of the drawing that corresponds to the map and drawing id. If Set to {{code|round}}({{code|0}}) the drawing will display with round line ends, but if set to {{code|square}}({{code|1}}) the drawing display with square line ends and angled corners.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getLineCap(mapName, drawingId, capType)
getLineCap(mapRef, drawingId, capType)
</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|capType|The value of the setting to set, {{code|round}}({{code|0}}) or {{code|square}}({{code|1}}).}}
{{param|capType|The value of the setting to set, {{code|round}}({{code|0}}) or {{code|square}}({{code|1}}).}}
|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:setLineCap("Grasslands", "0000000094218C675800000000000000",0)]
[h:setLineCap("Grasslands", "0000000094218C675800000000000000",0)]
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")]
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")]
[h:setLineCap("Grasslands", "00000000CCF6B567CC00000000000000",1)]
[h:setLineCap("Grasslands", "00000000CCF6B567CC00000000000000",1)]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|getLineCap}} {{func|refreshDrawing}}
{{func|getLineCap}} {{func|refreshDrawing}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Latest revision as of 23:59, 14 March 2023

setLineCap() Function

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

Introduced in version 1.5.0
Sets the line cap setting of the drawing that corresponds to the map and drawing id. If Set to round(0) the drawing will display with round line ends, but if set to square(1) the drawing display with square line ends and angled corners.

Usage

getLineCap(mapRef, drawingId, capType)

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.
  • capType - The value of the setting to set, round(0) or square(1).

Example

[h:setLineCap("Grasslands", "0000000094218C675800000000000000",0)]
[h:refreshDrawing("Grasslands", "0000000094218C675800000000000000")]
[h:setLineCap("Grasslands", "00000000CCF6B567CC00000000000000",1)]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]

See Also