refreshDrawing: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page RefreshDrawing to refreshDrawing: Converting page titles to lowercase)
No edit summary
 
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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
refreshDrawing(mapName, drawingId)
refreshDrawing(mapName, drawingId)
</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|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=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")]
[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setFillColor}}
{{func|setFillColor}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Latest revision as of 22:33, 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(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 drawing ids is via the Draw Explorer interface.

Example

[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]

See Also