setDrawingProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetDrawingProperties to setDrawingProperties: Converting page titles to lowercase)
No edit summary
 
(One intermediate revision by the same user 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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setDrawingProperties(mapName, drawingId, properties)
setDrawingProperties(mapRef, drawingId, properties)
</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|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=
<source lang="mtmacro" line>
<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))]
</source>
</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))]

See Also