findDrawings

From RPTools Wiki
Revision as of 19:49, 19 August 2021 by Phergus (talk | contribs) (Updated with wildcard option for drawing name.)
Jump to navigation Jump to search

findDrawings() Function

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

• Introduced in version 1.5.0
Returns the id or ids of any drawing on the specified map that matches the name parameter.

Usage

findDrawings(mapName, name)
findDrawings(mapName, name, delim)

Parameters

  • mapName - A string containing the name of the map.
  • name - A string containing name of the searched for drawings. Pass "*" to get all drawings. Drawings can be named via the Draw Explorer interface or using setDrawingName().
  • delim - Optional separator. If not specified, the default value "," is used. If "json" is specified, a JSON array is returned instead of a String List.

Example

[h:id=findDrawings("Grasslands", "block")]
[h:setFillColor("Grasslands", id,"#000000")]
[h:refreshDrawing("Grasslands", id)]

See Also

setFillColor() refreshDrawing() setDrawingName()

Version Changes

  • 1.10.0 - Added wildcard option for drawing name.
Retrieved from "https://wiki.rptools.info/index.php?title=findDrawings&oldid=11527"