getDrawingProperties: Difference between revisions

From RPTools Wiki
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")
Line 7: Line 7:
It cannot be stored in a script variable.
It cannot be stored in a script variable.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getDrawingProperties(mapName, drawingId)
getDrawingProperties(mapName, drawingId)
</source>
</source>
Line 14: Line 14:
{{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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: fromId="0000000074836E675D00000000000000"]
[h: fromId="0000000074836E675D00000000000000"]
[r: getDrawingProperties("Grasslands", fromId))]
[r: getDrawingProperties("Grasslands", fromId))]

Revision as of 17:42, 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

<syntaxhighlight lang="mtmacro" line> getDrawingProperties(mapName, drawingId) </source> 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

<syntaxhighlight lang="mtmacro" line>

[h: fromId="0000000074836E675D00000000000000"] [r: getDrawingProperties("Grasslands", fromId))]

</source>

See Also