refreshDrawing: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page refreshDrawing to RefreshDrawing without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
Causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync. | Causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
refreshDrawing( | refreshDrawing(mapRef, drawingId) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|mapRef|The Name or ID of the map.}} | ||
{{param|drawingId|A string containing the id of the drawing. The easiest way to discover drawing ids is via the '''Draw Explorer''' interface.}} | {{param|drawingId|A string containing the id of the drawing. The easiest way to discover drawing ids is via the '''Draw Explorer''' interface.}} | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")] | [h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")] | ||
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")] | [h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setFillColor}} | {{func|setFillColor}} | ||
}} | }} | ||
[[Category:Draw Function]] | [[Category:Draw Function]] | ||
Latest revision as of 23:59, 14 March 2023
refreshDrawing() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync.
Usage
refreshDrawing(mapRef, drawingId)Parameters
mapRef- The Name or ID of the map.drawingId- A string containing the id of the drawing. The easiest way to discover drawing ids is via the Draw Explorer interface.
Example
[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]