findDrawings: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Updated with wildcard option for drawing name.)
Line 4: Line 4:
|trusted=true
|trusted=true
|description=
|description=
Returns the id or ids of any drawing on the specified map that match the name parameter.
Returns the id or ids of any drawing on the specified map that matches the name parameter.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
findDrawings(mapName, name)
findDrawings(mapName, name)
findDrawings(mapName, name, delim)
findDrawings(mapName, name, delim)
</source>
</syntaxhighlight >
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{param|mapName|A string containing the name of the map.}}
{{param|name|A string containing name of the searched for drawings. The only way to name a drawing is via the Draw Explorer interface.}}
{{param|name|A string containing name of the searched for drawings. Pass {{code|"*"}} to get all drawings.  Drawings can be named via the Draw Explorer interface or using {{func|setDrawingName}}.}}
{{param|delim|Optional separator. If not specified the default value {{code|","}} is used.  If {{code|"json"}} is specified, a JSON array is returned instead of a String List.}}
{{param|delim|Optional separator. If not specified, the default value {{code|","}} is used.  If {{code|"json"}} is specified, a JSON array is returned instead of a String List.}}
|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:id=findDrawings("Grasslands", "block")]
[h:id=findDrawings("Grasslands", "block")]
[h:setFillColor("Grasslands", id,"#000000")]
[h:setFillColor("Grasslands", id,"#000000")]
[h:refreshDrawing("Grasslands", id)]
[h:refreshDrawing("Grasslands", id)]
</source>
</syntaxhighlight >
|also=
|also=
{{func|setFillColor}} {{func|refreshDrawing}}
{{func|setFillColor}} {{func|refreshDrawing}} {{func|setDrawingName}}
|changes=
* '''1.10.0''' - Added wildcard option for drawing name.
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Revision as of 19:49, 19 August 2021

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

Version Changes

  • 1.10.0 - Added wildcard option for drawing name.