getDrawingInfo: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:
|examples=
|examples=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: dinfo = getDrawingInfo("Arid", "B7041D43935D4BDCA330E431D892DEAB")]
[h: id = findDrawings(getCurrentMapName(),"Funky Shape")]
[h: dinfo = getDrawingInfo(getCurrentMapName(), id)]
<pre>[r: json.indent(dinfo,2)]</pre>
<pre>[r: json.indent(dinfo,2)]</pre>
</source>
</source>

Revision as of 13:15, 2 April 2019

getDrawingInfo() Function

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

Introduced in version 1.5.2
Returns extensive information about the specified drawing. The information is returned as a JSON object.

Usage

getDrawingInfo(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: id = findDrawings(getCurrentMapName(),"Funky Shape")]
[h: dinfo = getDrawingInfo(getCurrentMapName(), id)]
<pre>[r: json.indent(dinfo,2)]</pre>

Returns

{
  "fillColor": "#ffffff",
  "path":   [
        {
      "x": 250,
      "y": 200
    },
        {
      "x": 250,
      "y": 400
    },
        {
      "x": 500,
      "y": 400
    },
        {
      "x": 500,
      "y": 200
    },
        {
      "x": 400,
      "y": 200
    },
        {
      "x": 400,
      "y": 300
    },
        {
      "x": 350,
      "y": 300
    },
        {
      "x": 350,
      "y": 200
    },
        {
      "x": 250,
      "y": 200
    }
  ],
  "penWidth": 3,
  "name": "Funky Shape",
  "bounds":   {
    "x": 250,
    "width": 250,
    "y": 200,
    "height": 200
  },
  "penColor": "#000000",
  "id": "B7041D43935D4BDCA330E431D892DEAB",
  "type": "Polygon",
  "opacity": 1,
  "isEraser": 0,
  "layer": "TOKEN"
}

See Also