setDrawingProperties: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page setDrawingProperties to SetDrawingProperties without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
Sets the properties for a specified drawing. Currently this can only be used in conjunction with the getDrawingProperties function. | Sets the properties for a specified drawing. Currently this can only be used in conjunction with the getDrawingProperties function. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setDrawingProperties( | setDrawingProperties(mapRef, drawingId, properties) | ||
</ | </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|properties|The properties of another drawing. Currently this can only be delivered via the getDrawingProperties function}} | {{param|properties|The properties of another drawing. Currently this can only be delivered via the getDrawingProperties function}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:fromId="0000000074836E675D00000000000000"] | [h:fromId="0000000074836E675D00000000000000"] | ||
[h:toId="0000000095C36B437D00000000000000"] | [h:toId="0000000095C36B437D00000000000000"] | ||
[h:setDrawingProperties("Grasslands", toId, getDrawingProperties("Grasslands", fromId))] | [h:setDrawingProperties("Grasslands", toId, getDrawingProperties("Grasslands", fromId))] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getDrawingProperties}} | {{func|getDrawingProperties}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 14 March 2023
setDrawingProperties() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Sets the properties for a specified drawing. Currently this can only be used in conjunction with the getDrawingProperties function.
Usage
setDrawingProperties(mapRef, drawingId, properties)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.properties- The properties of another drawing. Currently this can only be delivered via the getDrawingProperties function
Examples
[h:fromId="0000000074836E675D00000000000000"]
[h:toId="0000000095C36B437D00000000000000"]
[h:setDrawingProperties("Grasslands", toId, getDrawingProperties("Grasslands", fromId))]