removeDrawing: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{stub|Examples of usage.}} {{MacroFunction |name=removeDrawing |version=1.3b51 |description= Removes a drawing from the named map. |usage= <syntaxhighlight lang="mtmacro" line> removeDrawing(mapname, drawingID) </syntaxhighlight> '''Parameters''' {{param|mapname|The name of the map to find the token. Defaults to the current map.}} {{param|DrawingID|The ID of the drawing to be removed.}} Both are required. The Drawing ID can be gotten from the Draw Explorer panel. =...")
 
m (recategorised from metamacro to drawing)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=removeDrawing
|name=removeDrawing
|version=1.3b51
|description=
|description=
Removes a drawing from the named map.
Removes a drawing from the named map.
Line 8: Line 6:
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
removeDrawing(mapname, drawingID)
removeDrawing(mapRef, drawingId)
</syntaxhighlight>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
{{param|DrawingID|The ID of the drawing to be removed.}}
{{param|DrawingID|The ID of the drawing to be removed.}}


Both are required. The Drawing ID can be gotten from the Draw Explorer panel.
Both are required. The Drawing ID can be gotten from the Draw Explorer panel.
[[File:Get Drawing Id.png|500px|Drawing ID can be gotten from the Draw Explore panel.]]


==Examples==
==Examples==
Line 22: Line 24:
[h:removeDrawing("Grasslands", "935F44FC95A54719A05E204A4459F917")]}
[h:removeDrawing("Grasslands", "935F44FC95A54719A05E204A4459F917")]}
</syntaxhighlight>
</syntaxhighlight>
}}


 
[[Category:Draw Function]]
[[Category:Metamacro Function]]

Latest revision as of 23:59, 17 March 2024

removeDrawing() Function

Removes a drawing from the named map.

Usage

removeDrawing(mapRef, drawingId)

Parameters

  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.
  • DrawingID - The ID of the drawing to be removed.

Both are required. The Drawing ID can be gotten from the Draw Explorer panel.


Drawing ID can be gotten from the Draw Explore panel.


Examples

Remove a drawing with ID 935F44FC95A54719A05E204A4459F917 from a map named Grasslands.

[h:removeDrawing("Grasslands", "935F44FC95A54719A05E204A4459F917")]}