getDrawingProperties: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetDrawingProperties to getDrawingProperties: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (One intermediate revision by the same user not shown) | |||
| Line 7: | Line 7: | ||
It cannot be stored in a script variable. | It cannot be stored in a script variable. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getDrawingProperties(mapName, drawingId) | getDrawingProperties(mapName, drawingId) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|mapName|A string containing the name of the map.}} | {{param|mapName|A string containing the name 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.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: fromId="0000000074836E675D00000000000000"] | [h: fromId="0000000074836E675D00000000000000"] | ||
[r: getDrawingProperties("Grasslands", fromId))] | [r: getDrawingProperties("Grasslands", fromId))] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setDrawingProperties}} | {{func|setDrawingProperties}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 18:29, 14 March 2023
getDrawingProperties() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Returns the properties for a specified drawing. Currently this can only be used to set the properties of another drawing.
It cannot be stored in a script variable.
Usage
getDrawingProperties(mapName, drawingId)Parameters
mapName- A string containing the name 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.
Examples
[h: fromId="0000000074836E675D00000000000000"]
[r: getDrawingProperties("Grasslands", fromId))]